Získat API klíč
Obchodní API

Účet

Zůstatky, obchody, vklady a výběry účtu, ke kterému klíč patří, jen ke čtení.

Co budete potřebovat.

API klíč s oprávněním account a podpis požadavků. Všechny endpointy jsou jen ke čtení a jejich odpovědi se neukládají do cache. Výběr nelze přes API zadat ani zrušit.

Zůstatky

GET /v1/account/balances vrací jednu položku na měnu se stejnými čísly, jaká ukazuje přehled účtu v aplikaci. available je částka k okamžitému použití, held částka blokovaná a total jejich součet. Blokovaná částka se dělí na heldInOrders (otevřené pokyny) a heldInWithdrawals (probíhající výběry); co z ní zbude, je blokované z jiného důvodu, například vklad držený ke kontrole.

Částky jsou desetinné řetězce s počtem desetinných míst dané měny, který se mezi měnami liší, proto je zpracujte jako desetinná čísla. Měna, která nemá nic dostupného, blokovaného ani ve stakingu, se vynechává. Vynechává se i měna, ve které vám zbyl jen zůstatek menší než nejmenší obchodovatelné množství a nemáte ji ve stakingu; se stakingem v seznamu zůstává a tento zůstatek je v available a total.

Prostředky ve stakingu nese staked, včetně částky na cestě do stakingu a ve výpovědní lhůtě. Do total se nezapočítávají, protože je nelze použít pro pokyny ani výběry; vše, co v měně vlastníte, je totalOwned (total plus staked). Měna, kterou máte jen ve stakingu, je v seznamu s nulovým available, held i total. Staking se přes API jen čte, zahájit ani ukončit ho nelze.

Obchody

GET /v1/account/trades vrací obchody od nejnovějšího s údaji, které aplikace ukazuje v historii obchodů: trh, strana, naplněné množství, průměrná cena, poplatek Coinera, zaplacená a získaná částka a příznak settled. Obchod je pokyn naplněný celý nebo zčásti a každý pokyn je jedna položka: jednotlivá naplnění se nevydávají, takže tradeId se rovná orderId a pokyn si přečtete z GET /v1/orders/{orderId}. Čas obchodu je okamžik úplného naplnění; u pokynu naplněného jen zčásti, například zrušeného po částečném naplnění, je to čas jeho vytvoření.

Vklady a výběry

GET /v1/account/deposits a GET /v1/account/withdrawals vracejí bankovní převody i kryptoměnové převody dohromady (kind je fiat nebo crypto), tytéž položky, jaké aplikace Coinero ukazuje v přehledu vkladů a výběrů, včetně převodů mezi klienty Coinera. Pole, která pro daný převod nedávají smysl, jsou vždy přítomná s hodnotou null.

  • Výběr kryptoměny: amount je částka, kterou jste zadali, fee síťový poplatek (do odeslání odhad) a netAmount částka, která dorazí na adresu: amount minus fee, pokud je poplatek zahrnutý v částce, jinak amount. Adresu nese address a hash transakce txId po odeslání.
  • Bankovní převod: nemá poplatek (fee je null) a netAmount se rovná amount.
  • Maskované účty: odesílající účet vkladu a cílový účet výběru se vracejí jen jako poslední čtyři znaky čísla účtu a kód banky, například ***6789/0800; u IBANu jen poslední čtyři znaky.
  • Vklad připsaný z burzy (poslaný na adresu burzy nebo starší vkladovou adresu) se řadí a filtruje podle okamžiku zaúčtování, zatímco jeho createdAt je den transakce a může být dřívější.

Veřejné stavy vkladů a výběrů jsou hrubší než stavy v aplikaci. Aplikace u stavu onHold vysvětlí, na co se čeká. Neznámou hodnotu stavu zpracujte bez selhání: nové hodnoty mohou ve verzi v1 přibýt.

StavVýznam
pendingvklad se zpracovává
onHoldvklad čeká na kontrolu nebo na informaci od vás, například o odesílateli; podrobnosti ukáže aplikace
completedvklad je připsaný na účet
returnedvklad byl vrácen odesílateli
rejectedvklad byl odmítnut
failedvklad se nepodařilo zpracovat
StavVýznam
pendingvýběr se zpracovává (zadaný, čeká na schválení, schválený, odesílá se)
onHoldvýběr je pozastavený, například kvůli pravidlu Travel Rule
completedvýběr byl odeslán na adresu, potvrzen bankou nebo vypořádán uvnitř Coinera
cancelledvýběr byl zrušen a prostředky se vrátily na účet
rejectedvýběr byl odmítnut

Stránkování

Seznamy pokynů, obchodů, vkladů a výběrů přijímají page (od 1; výchozí 1) a limit (od 1 do 200; výchozí 50). Odpověď nese items, page, limit, hasMore (následuje další stránka) a total (počet položek odpovídajících filtrům). Filtry from a to berou čas ve formátu ISO 8601 (bez časového pásma se čas bere jako UTC) nebo milisekundy; interval je uzavřený zleva a otevřený zprava. Obchody se filtrují podle času obchodu, ostatní seznamy podle createdAt.

Stránkování podle offsetu má omezení.

Položka, která vznikne mezi dvěma stránkami, posune seznam a některá položka se pak zopakuje nebo chybí. Dlouhou historii proto čtěte po pevném intervalu: nastavte to na okamžik v minulosti, například čas zahájení čtení, a procházejte stránky, dokud je hasMore pravdivé. Ukázka je vpravo.

Seznam pokynů navíc umí filtr status, kde hodnota open zahrnuje všechny dosud otevřené pokyny (new, placing, open a partiallyFilled). Filtry přijmou i vyřazený pár, takže lze číst i jeho historii; neznámý pár vrací UNKNOWN_SYMBOL a neznámá měna UNKNOWN_CURRENCY.

Co API nevydává

  • Platby přes Lightning.
  • Pohyby před migrací z CoinBank, včetně obchodů z té doby.
  • Prodeje drobných zůstatků, které aplikace v historii ukazuje.
  • Zahájení a ukončení stakingu (stav stakingu je jen v zůstatcích).
  • Jednotlivá naplnění pokynů.
  • Síť a reference vkladů a výběrů a nemaskovaná čísla bankovních účtů.

Změny na účtu můžete místo dotazování odebírat přes kanály orders, balances, deposits a withdrawals WebSocketu. Zmeškané události se nedoplňují: po opětovném připojení si stav přečtěte z těchto endpointů. Kanály vkladů a výběrů zatím nepokrývají všechny druhy převodů, úplnou historii proto čtěte přes REST.