API dokumentace

Ú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

https://btcex.cz/api/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:

  • https://btcex.cz/api/price?type=buy&satoshi=100000000
  • https://btcex.cz/api/price?type=sell&pennies=123123
  • https://btcex.cz/api/price?affiliate=example.com&type=sell&pennies=123123
  • Výstup:

    [
        "affiliate": string|null,
        "type": "buy"|"sell",
        "satoshi": int,
        "pennies": int
    ]

    Order

    https://btcex.cz/api/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 (parametr bankAccount je ignorován)
  • při typu sell je vyžadován bankAccount (parametr btcAddress je ignorován)
  • 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) - ovař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)
  • dry (bool) - testovací požadavek (nevytvoří objednávku)
  • Příklady:

  • https://btcex.cz/api/order?affiliate=example.com[email protected]bar.cz&btcAddress=17QjH64ChLES11iM2Gbv65VDdijTFgRcXJ
  • https://btcex.cz/api/order?affiliate=example.co[email protected]bar.cz&bankAccount=2200073270/2010
  • Výstup:

    [
        "status": "ok,
        "dry": bool
    ]
    
    Tyto stránky používají soubory cookies pro zajištění objednávek, navigaci a odesílání zpráv.