Získat API klíč
Přehled API · Pokyny

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

Endpoint vyžaduje API klíč s oprávněním 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

ParametrPopis
orderIdpovinnéstringIdentifikátor pokynu (orderId), který chcete zrušit.

Odpověď

202 · application/json · OrderResponse

Zruš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.

PolePopis
orderIdstringIdentifikátor pokynu.
clientOrderIdstring nebo nullVáš 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.
symbolstringSymbol trhu tak, jak byl zadán při zadání pokynu, například BTCCZK.
basestringKód základní měny trhu.
quotestringKód kotovací měny trhu.
sidestringStrana pokynu z pohledu základní měny. Hodnoty: buy, sell.
typestringTyp pokynu. Hodnoty: market, limit.
statusstringStav pokynu. Hodnoty: new, placing, open, partiallyFilled, filled, cancelled, expired, rejected, pendingConfirmation.
settledbooleanTrue, 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.
cancellablebooleanTrue, když lze pokyn v jeho stavu zrušit.
requestedQuantitystring nebo nullMnož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 nullLimitní 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 nullNaplně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 nullPrů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 nullPoplatek 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.currencystringKó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.currencystringKó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.currencystringKód měny částky, například BTC nebo CZK.
conversionOrderConversionResponse nebo nullPř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.ratestringKlientský 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.currencystringKód můstkové měny, přes kterou se pokyn provádí, například EUR.
rejectionReasonstring nebo nullProč byl pokyn odmítnut, nebo null, když odmítnut nebyl. Pole je v odpovědi vždy.
createdAtstringKdy byl pokyn vytvořen, ISO 8601, UTC, s milisekundami.
createdAtMsinteger (int64)Stejný okamžik jako Unix timestamp v milisekundách.
filledAtstring nebo nullKdy byl pokyn naplněn celý, ISO 8601, UTC, jinak null. Pole je v odpovědi vždy.
filledAtMsinteger nebo nullStejný okamžik jako Unix timestamp v milisekundách. Případně null. Pole je v odpovědi vždy.
settledAtstring nebo nullKdy byl pokyn vypořádán, ISO 8601, UTC, jinak null. Pole je v odpovědi vždy.
settledAtMsinteger nebo nullStejný 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.externalClientRefstringIdentifikátor klienta ve vašem systému, za kterého pokyn je.
partner.feeAmountApiMoneyPoplatek 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.currencystringKód měny částky, například BTC nebo CZK.
partner.totalAmountApiMoney nebo nullNá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.currencystringKód měny částky, například BTC nebo CZK.
partner.netProceedsApiMoney nebo nullProdej: 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.currencystringKód měny částky, například BTC nebo CZK.
partner.blockDeadlinestring nebo nullDo kdy musíte blokaci potvrdit, ISO 8601, UTC; jen ve stavu pendingConfirmation, jinak null. Pole je v odpovědi vždy.
partner.blockDeadlineMsinteger nebo nullStejný okamžik jako Unix timestamp v milisekundách. Případně null. Pole je v odpovědi vždy.
partner.confirmationRequiredbooleanTrue, když pokyn čekal na vaše potvrzení blokace; u prodeje a u partnera bez potvrzování false.
partner.confirmedAtstring nebo nullKdy jste blokaci potvrdili, ISO 8601, UTC, jinak null. Pole je v odpovědi vždy.
partner.confirmedAtMsinteger nebo nullStejný okamžik jako Unix timestamp v milisekundách. Případně null. Pole je v odpovědi vždy.
partner.settledAtstring nebo nullKdy 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 nullStejný 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í.

PublicOrderSideVýznam
buynákup: platíte kotovací měnou a získáváte základní měnu
sellprodej: platíte základní měnou a získáváte kotovací měnu
PublicOrderTypeVýznam
markettržní pokyn se provede za aktuální tržní cenu
limitlimitní pokyn se provede za zadanou limitní cenu nebo lepší
PublicOrderStatusVýznam
newpokyn byl přijat a čeká na odeslání na burzu
placingpokyn se odesílá na burzu
openpokyn čeká na burze na naplnění
partiallyFilledpokyn je zčásti naplněný
filledpokyn je naplněný celý; vypořádání může následovat později (viz settled)
cancelledpokyn byl zrušen
expiredplatnost pokynu vypršela
rejectedpokyn byl odmítnut (viz rejectionReason)
pendingConfirmationjen 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.

StavKódyŘešení
401MISSING_API_KEY, INVALID_API_KEY, SIGNATURE_REQUIRED, INVALID_SIGNATURE, TIMESTAMP_OUT_OF_WINDOWDoplň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.
403INSUFFICIENT_PERMISSION, IP_NOT_ALLOWEDPole 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.
404ORDER_NOT_FOUNDOvěřte orderId; pokyn jiného účtu a identifikátor, který není GUID, vracejí stejnou chybu.
405METHOD_NOT_ALLOWEDPoužijte metodu z hlavičky Allow: GET a HEAD ke čtení, POST a DELETE jen u operací, které je mají v dokumentaci.
409ORDER_NOT_CANCELLABLEPřečtěte pokyn a zkontrolujte stav; zrušit lze jen open a partiallyFilled. Opakování nepomůže, dokud se stav nezmění.
429RATE_LIMIT_EXCEEDEDPřed dalším pokusem vyčkejte počet sekund z Retry-After.
503SERVICE_MAINTENANCE, MARKET_DATA_UNAVAILABLEProbí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.