DELETE /v1/orders/{orderId}
Požádá o zrušení otevřeného pokynu účtu, stejným požadavkem jako zrušení v aplikaci Coinero.
Podepsaný požadavek s oprávněním trade
trade a podpis požadavku. Postup je na stránce Podpis požadavků, oprávnění vysvětluje Oprávnění a životnost klíče.Parametry cesty
| Parametr | Popis |
|---|---|
| orderIdpovinnéstring | Identifikátor pokynu (orderId), který chcete zrušit. |
Odpověď
202 · application/json · OrderResponseZrušit lze jen pokyn s cancellable true (stav open nebo partiallyFilled); pokyn v jiném stavu, i už zrušený, vrací 409 ORDER_NOT_CANCELLABLE.
Zrušení je asynchronní: odpověď 202 nese pokyn tak, jak vypadal při přijetí požadavku, typicky ještě otevřený. Stav se změní na cancelled (nebo na filled, pokud se pokyn stihl naplnit) až po potvrzení burzou; pokyn si přečtěte znovu nebo sledujte kanál orders ve WebSocketu.
Opakování požadavku během čekání na zrušení nevadí. Zrušení se počítá do obecného limitu požadavků, ne do limitu zadaných pokynů.
Odpověď se neukládá do cache.
Částky a ceny jsou desetinné řetězce, aby nedocházelo ke ztrátě přesnosti. Volitelná pole mohou v odpovědi zcela chybět; nenahrazují se hodnotou null.
| Pole | Popis |
|---|---|
| orderIdstring | Identifikátor pokynu. |
| clientOrderIdstring nebo null | Váš vlastní identifikátor pokynu tak, jak jste ho poslali, nebo null, když jste pokyn zadali bez něj. Pole je v odpovědi vždy. |
| symbolstring | Symbol trhu tak, jak byl zadán při zadání pokynu, například BTCCZK. |
| basestring | Kód základní měny trhu. |
| quotestring | Kód kotovací měny trhu. |
| sidestring | Strana pokynu z pohledu základní měny. Hodnoty: buy, sell. |
| typestring | Typ pokynu. Hodnoty: market, limit. |
| statusstring | Stav pokynu. Hodnoty: new, placing, open, partiallyFilled, filled, cancelled, expired, rejected, pendingConfirmation. |
| settledboolean | True, jakmile je pokyn vypořádaný na účtu. Naplněný pokyn se vypořádá krátce po naplnění; do té doby se získaná částka ještě může změnit. |
| cancellableboolean | True, když lze pokyn v jeho stavu zrušit. |
| requestedQuantitystring nebo null | Množství v základní měně, které jste zadali, nebo null, když jste zadali quoteQuantity. Právě jedno z requestedQuantity a requestedQuoteQuantity je vyplněné. Pole je v odpovědi vždy. |
| requestedQuoteQuantitystring nebo null | Částka v kotovací měně, kterou jste zadali, nebo null, když jste zadali quantity. Pole je v odpovědi vždy. |
| pricestring nebo null | Limitní cena v kotovací měně za jednotku základní měny tak, jak jste ji zadali (u trhů v CZK v CZK), nebo null u tržního pokynu. Pole je v odpovědi vždy. |
| filledQuantitystring nebo null | Naplněné množství v základní měně jako desetinný řetězec. Null na trhu, který Coinero kotuje opačně než burza (například USDCBTC), kde pokyn drží naplněné množství v kotovací měně. Pole je v odpovědi vždy. |
| averagePricestring nebo null | Průměrná cena naplnění v kotovací měně za jednotku základní měny, u trhů v CZK přepočtená kurzem pokynu, s nejméně šesti platnými číslicemi. Do prvního naplnění null. Pole je v odpovědi vždy. |
| feeApiMoney nebo null | Poplatek Coinera za pokyn, tedy údaj, který aplikace ukazuje jako poplatek. Do naplnění nula. Null jen tehdy, když není známa měna poplatku. Pole je v odpovědi vždy. |
| fee.amountstring | Částka jako desetinný řetězec s tečkou a nejméně s tolika místy, kolik má její měna. Zpracujte ji jako desetinné číslo, ne jako číslo s pohyblivou řádovou čárkou. |
| fee.currencystring | Kód měny částky, například BTC nebo CZK. |
| spentApiMoney | Částka, kterou jste skutečně zaplatili, v měně, kterou pokyn utrácí. Do naplnění nula. |
| spent.amountstring | Částka jako desetinný řetězec s tečkou a nejméně s tolika místy, kolik má její měna. Zpracujte ji jako desetinné číslo, ne jako číslo s pohyblivou řádovou čárkou. |
| spent.currencystring | Kód měny částky, například BTC nebo CZK. |
| receivedApiMoney | Částka, kterou jste skutečně získali, v měně, do které pokyn nakupuje nebo prodává, po odečtení poplatku Coinera. Do naplnění nula. |
| received.amountstring | Částka jako desetinný řetězec s tečkou a nejméně s tolika místy, kolik má její měna. Zpracujte ji jako desetinné číslo, ne jako číslo s pohyblivou řádovou čárkou. |
| received.currencystring | Kód měny částky, například BTC nebo CZK. |
| conversionOrderConversionResponse nebo null | Převod přes můstkovou měnu u trhů, které Coinero kotuje v měně, již burza neobchoduje (například CZK přes EUR), kurzem stanoveným pro tento pokyn; u přímo obchodovaných trhů null. Pole je v odpovědi vždy. |
| conversion.ratestring | Klientský kurz stanovený pro pokyn jako desetinný řetězec: počet jednotek kotovací měny trhu na jednu jednotku můstkové měny, například 25.2525 CZK za 1 EUR. Aplikace ho ukazuje jako použitý kurz. |
| conversion.currencystring | Kód můstkové měny, přes kterou se pokyn provádí, například EUR. |
| rejectionReasonstring nebo null | Proč byl pokyn odmítnut, nebo null, když odmítnut nebyl. Pole je v odpovědi vždy. |
| createdAtstring | Kdy byl pokyn vytvořen, ISO 8601, UTC, s milisekundami. |
| createdAtMsinteger (int64) | Stejný okamžik jako Unix timestamp v milisekundách. |
| filledAtstring nebo null | Kdy byl pokyn naplněn celý, ISO 8601, UTC, jinak null. Pole je v odpovědi vždy. |
| filledAtMsinteger nebo null | Stejný okamžik jako Unix timestamp v milisekundách. Případně null. Pole je v odpovědi vždy. |
| settledAtstring nebo null | Kdy byl pokyn vypořádán, ISO 8601, UTC, jinak null. Pole je v odpovědi vždy. |
| settledAtMsinteger nebo null | Stejný okamžik jako Unix timestamp v milisekundách. Případně null. Pole je v odpovědi vždy. |
| partnervolitelnéPartnerOrderBlockResponse | Údaje pokynu za subúčet vašeho partnerského účtu: číslo pokynu, poplatek partnera, částka k blokaci, potvrzení a vypořádání s partnerem. Jen u pokynů subúčtů; pokyny klientského účtu pole nemají. |
| partner.orderNumberstring | Číslo pokynu vašeho partnerského účtu, například ABCD-0000001234; jeho číslice jsou variabilním symbolem platby za pokyn. |
| partner.externalClientRefstring | Identifikátor klienta ve vašem systému, za kterého pokyn je. |
| partner.feeAmountApiMoney | Poplatek partnera: u nákupu navíc k investici (po vypořádání obchodu skutečně zaúčtovaný), u prodeje z hrubého výtěžku (do vypořádání obchodu nula). |
| partner.feeAmount.amountstring | Částka jako desetinný řetězec s tečkou a nejméně s tolika místy, kolik má její měna. Zpracujte ji jako desetinné číslo, ne jako číslo s pohyblivou řádovou čárkou. |
| partner.feeAmount.currencystring | Kód měny částky, například BTC nebo CZK. |
| partner.totalAmountApiMoney nebo null | Nákup: investice plus poplatek partnera, tedy částka, kterou klientovi zablokujete a Coineru zaplatíte. U prodeje null. Pole je v odpovědi vždy. |
| partner.totalAmount.amountstring | Částka jako desetinný řetězec s tečkou a nejméně s tolika místy, kolik má její měna. Zpracujte ji jako desetinné číslo, ne jako číslo s pohyblivou řádovou čárkou. |
| partner.totalAmount.currencystring | Kód měny částky, například BTC nebo CZK. |
| partner.netProceedsApiMoney nebo null | Prodej: výtěžek po poplatku partnera, který vám Coinero vyplatí; do vypořádání obchodu null. U nákupu null. Pole je v odpovědi vždy. |
| partner.netProceeds.amountstring | Částka jako desetinný řetězec s tečkou a nejméně s tolika místy, kolik má její měna. Zpracujte ji jako desetinné číslo, ne jako číslo s pohyblivou řádovou čárkou. |
| partner.netProceeds.currencystring | Kód měny částky, například BTC nebo CZK. |
| partner.blockDeadlinestring nebo null | Do kdy musíte blokaci potvrdit, ISO 8601, UTC; jen ve stavu pendingConfirmation, jinak null. Pole je v odpovědi vždy. |
| partner.blockDeadlineMsinteger nebo null | Stejný okamžik jako Unix timestamp v milisekundách. Případně null. Pole je v odpovědi vždy. |
| partner.confirmationRequiredboolean | True, když pokyn čekal na vaše potvrzení blokace; u prodeje a u partnera bez potvrzování false. |
| partner.confirmedAtstring nebo null | Kdy jste blokaci potvrdili, ISO 8601, UTC, jinak null. Pole je v odpovědi vždy. |
| partner.confirmedAtMsinteger nebo null | Stejný okamžik jako Unix timestamp v milisekundách. Případně null. Pole je v odpovědi vždy. |
| partner.settledAtstring nebo null | Kdy byl pokyn vypořádán s vaším partnerským účtem (spárovaná platba nebo odeslaná výplata), ISO 8601, UTC, jinak null. Pole settled pokynu je vypořádání obchodu na účtu, ne tohle. Pole je v odpovědi vždy. |
| partner.settledAtMsinteger nebo null | Stejný okamžik jako Unix timestamp v milisekundách. Případně null. Pole je v odpovědi vždy. |
Hodnoty stavů
Nové hodnoty mohou přibýt i v rámci v1; neznámou hodnotu zpracujte bez selhání.
| PublicOrderSide | Význam |
|---|---|
buy | nákup: platíte kotovací měnou a získáváte základní měnu |
sell | prodej: platíte základní měnou a získáváte kotovací měnu |
| PublicOrderType | Význam |
|---|---|
market | tržní pokyn se provede za aktuální tržní cenu |
limit | limitní pokyn se provede za zadanou limitní cenu nebo lepší |
| PublicOrderStatus | Význam |
|---|---|
new | pokyn byl přijat a čeká na odeslání na burzu |
placing | pokyn se odesílá na burzu |
open | pokyn čeká na burze na naplnění |
partiallyFilled | pokyn je zčásti naplněný |
filled | pokyn je naplněný celý; vypořádání může následovat později (viz settled) |
cancelled | pokyn byl zrušen |
expired | platnost pokynu vypršela |
rejected | pokyn byl odmítnut (viz rejectionReason) |
pendingConfirmation | jen pokyn za subúčet: pokyn je přijatý a čeká, až partner potvrdí blokaci prostředků; nic se zatím nezaúčtovalo |
Chyby
Chyby mají formát application/problem+json; zpracovávejte je podle pole code. Podrobnosti najdete v přehledu chyb.
| Stav | Kódy | Řešení |
|---|---|---|
| 401 | MISSING_API_KEY, INVALID_API_KEY, SIGNATURE_REQUIRED, INVALID_SIGNATURE, TIMESTAMP_OUT_OF_WINDOW | Doplňte hlavičku X-COINERO-APIKEY. Ověřte hodnotu a stav klíče i aktivitu účtu. Doplňte hlavičky X-COINERO-TIMESTAMP a X-COINERO-SIGNATURE podle stránky Podpis požadavků. Zkontrolujte kanonický řetězec (časová značka, metoda velkými písmeny, cesta s dotazem, tělo bajt po bajtu) a že secret před HMAC dekódujete z Base64; stránka Podpis požadavků má referenční vektor. Použijte aktuální čas v milisekundách; pole serverTime a serverTimeMs v odpovědi nesou čas serveru, podle kterého opravte hodiny klienta. |
| 403 | INSUFFICIENT_PERMISSION, IP_NOT_ALLOWED | Pole requiredPermission uvádí, které oprávnění chybí. Oprávnění klíče nelze změnit; vytvořte nový klíč s potřebným oprávněním. Odešlete požadavek z adresy povolené u klíče, nebo vytvořte nový klíč, jehož seznam adresu obsahuje; seznam nelze dodatečně změnit. |
| 404 | ORDER_NOT_FOUND | Ověřte orderId; pokyn jiného účtu a identifikátor, který není GUID, vracejí stejnou chybu. |
| 405 | METHOD_NOT_ALLOWED | Použijte metodu z hlavičky Allow: GET a HEAD ke čtení, POST a DELETE jen u operací, které je mají v dokumentaci. |
| 409 | ORDER_NOT_CANCELLABLE | Přečtěte pokyn a zkontrolujte stav; zrušit lze jen open a partiallyFilled. Opakování nepomůže, dokud se stav nezmění. |
| 429 | RATE_LIMIT_EXCEEDED | Před dalším pokusem vyčkejte počet sekund z Retry-After. |
| 503 | SERVICE_MAINTENANCE, MARKET_DATA_UNAVAILABLE | Probíhá údržba nebo je dočasně vypnuté obchodování či WebSocket; ověřte GET /v1/status a vyčkejte podle Retry-After. Data dočasně chybí; vyčkejte počet sekund z Retry-After a požadavek zopakujte. |