Legacy

DEPRECATED

Tato verze api je je zastaralá a může být kdykoli vypnuta, prosím implementujte novou: docs.btcex.cz

Úvod

Naše API se volá ve formě GET požadavků, odpovědí je JSON.

Chyby

V případě špatného požadavku, či chybných dat api vrátí chybu ve formátu:

{
    "error": string
}

Metody:

Price

http://legacyapi.btcex.cz/price

Slouží k získání přepočtu ceny směny.

je třeba zadat pouze jednu vstupní částku, tedy satoshi, nebo pennies

Vstupní parametry:

affiliate (string|null) - jméno affiliate partnera
type (buy|sell) - typ směny
satoshi (int) - počet satoshi
pennies (int) - počet halérů

Příklady:

Výstup:

{
    "affiliate": string|null,
    "type": "buy"|"sell",
    "satoshi": int,
    "pennies": int
}

Order

http://legacyapi.btcex.cz/order

Slouží k vytváření objedávek.

je třeba zadat pouze jednu vstupní částku, tedy satoshi, nebo pennies
při typu buy je vyžadován btcAddress, nebo depositPhone (parametr bankAccount je ignorován)
při typu sell je vyžadován bankAccount (parametry btcAddress a depositPhone jsou ignorovány)
pro účely testování využijte parametr dry, chování je identické, ovšem objednávka se nevytvoří

Vstup:

affiliate (string) - jméno affiliate partnera
key (string) - ověřovací klíč partnera
type (buy|sell) - typ směny
satoshi (int|null) - počet satoshi
pennies (int|null) - počet halérů
email (string)
bankAccount (string|null)
btcAddress (string|null)
depositPhone (string|null) - telefon k uložení btc (formát +420XXXYYYZZZ)
ipAddress (string|null) - IPv4 adresa zákazníka
cookie (string|null) - cookie id zákazníka
dry (bool) - testovací požadavek (nevytvoří objednávku)

Příklady:

Výstup:

{
    "status": "ok",
    "orderId": int,
    "dry": bool
}

orderId id objednávky, při testovacím požadavku vrací 0

Order-list

http://legacyapi.btcex.cz/order-list

Slouží k získání informací o objednávkách.

Vstup:

affiliate (string) - jméno affiliate partnera
key (string) - ověřovací klíč partnera
orderByChanged (bool) - řadit podle poslední aktualizace? (default 0)
offset (int|null) - počet přeskočených záznamů (default 0)
limit (int|null) - počet vrácených záznamů (max&default 100)
id (int|null) - id transakce (vrátí pouze jednu, offset a limit jsou ignorovány)

Příklady:

Výstup:

[
    {
        "id": int,
        "uuid": string,
        "type": "buy"|"sell",
        "created": "2020-08-24 13:28:36",
        "finished": "2020-08-24 17:34:23"|null,
        "changed": "2020-08-24 17:34:23"|null,
        "success": true|false,
        "email": string,
        "pennies": int,
        "satoshi": int,
        "commission": int,
        "outgoingTxId": string|null,
        "outgoingTxConfirmed": bool
    },
    {...},
    {...}
]

uuid interní unikátní ID objednávky
success indikuje, zda-li byla objednávka úspěšně dokončena (obchod proběhl)
email email klienta
pennies aktuální množství halérú
satoshi aktuální množství halérú
commission výše Vaší provize v haléřích
outgoingTxId ID transakce ve které byla platba odeslána
outgoingTxConfirmed zda-li byla ochozí transakce již potvrzena
řezeno od novějších po nejstarší

Check-btc-address

http://legacyapi.btcex.cz/check-btc-address

Slouží k validaci zadané btc adresy.

Vstup:

btcAddress (string|null)

Příklady:

Výstup:

{
    "address": string|null,
    "type": "P2PKH"|"P2SH"|"Bech32"|null,
    "valid": bool
}