Získat API klíč
Přehled API · Subúčty

POST /v1/subaccounts/{externalClientRef}/orders/validate

Provede stejné kontroly jako zadání pokynu za subúčet a vrátí odhad s poplatkem partnera bez založení pokynu.

Partnerský klíč s oprávněním subaccounts

Endpoint patří do sekce Subúčty. Vyžaduje partnerský API klíč (prefix pk_) s oprávněním subaccounts a podpis požadavku; klientský klíč dostane 403 INSUFFICIENT_PERMISSION. Postup je na stránkách Podpis požadavků a Klíč partnera.

Parametry cesty

ParametrPopis
externalClientRefpovinnéstringIdentifikátor klienta ve vašem systému přesně tak, jak jste ho poslali při založení subúčtu, včetně velikosti písmen: 1 až 64 písmen bez diakritiky, číslic, pomlček a podtržítek.

Tělo požadavku

application/json · PlaceSubaccountOrderBody

Podepište a odešlete bajt po bajtu totéž tělo, bez přeformátování. Neznámá pole API ignoruje a pole s hodnotou null je totéž jako pole vynechané.

PolePopis
symbolpovinnéstringSymbol trhu z allowedMarkets subúčtu, kotovaný v měně vypořádání vašeho partnerského účtu, například BTCCZK; velikost písmen nerozhoduje.
sidepovinnéstringbuy nebo sell z pohledu základní měny trhu. Jen malými písmeny. Hodnoty: buy, sell.
typepovinnéstringmarket. Jiný typ vrací ORDER_TYPE_NOT_ALLOWED. Hodnoty: market, limit.
quantityvolitelnéstringProdej: množství základní měny k prodeji jako desetinný řetězec, například "0.01". U nákupu a spolu se sellAll nepovolené.
quoteQuantityvolitelnéstringNákup: částka kotovací měny k investování jako desetinný řetězec, bez poplatku partnera, který se připočte navíc. U prodeje nepovolené.
sellAllvolitelnébooleanProdej: true prodá celou dostupnou pozici; quantity se pak neposílá.
clientOrderIdvolitelnéstringVáš identifikátor pokynu, 1 až 64 písmen, číslic, pomlček a podtržítek, jedinečný pro partnerský účet. U zadání povinný: opakování se stejným clientOrderId vrátí existující pokyn. U ověření nepovinný.

Odpověď

200 · application/json · PartnerValidateOrderResponse

Odhad nese cenu (buyPrice nebo sellPrice z GET /v1/ticker), poplatek partnera, u nákupu částku k blokaci (total), u prodeje čistý výtěžek (netProceeds), meze pokynu a zbývající denní limit klienta.

Odmítnutí není chyba: odpověď je 200 s valid false a kódem, se kterým by skončilo zadání. clientOrderId je nepovinné.

Vyžaduje partnerský API klíč s oprávněním subaccounts a podepsaný požadavek. Funguje pro subúčet v každém stavu kromě zamítnutého; neexistující, cizí nebo zamítnutý subúčet vrací 404 CLIENT_NOT_FOUND.

Nepočítá se do limitu zadání pokynů. Odpověď se neukládá do cache.

Částky a ceny jsou desetinné řetězce, aby nedocházelo ke ztrátě přesnosti.

PolePopis
validbooleanTrue, když by zadání pokynu s tímto tělem teď prošlo.
estimatePartnerOrderEstimateResponse nebo nullOdhad pokynu, nebo null, když je valid false. Pole je v odpovědi vždy.
estimate.symbolstringSymbol trhu, jak jste ho zadali.
estimate.sidestringStrana pokynu. Hodnoty: buy, sell.
estimate.pricestringCena jednotky základní měny v kotovací měně: buyPrice u nákupu a sellPrice u prodeje z GET /v1/ticker, s níž ochranná mez porovná cenu při potvrzení.
estimate.quantitystringNákup: horní odhad získaného množství (investice děleno cenou). Prodej: prodávané množství.
estimate.quantityIsUpperEstimatebooleanTrue u nákupu: skutečně naplněné množství bývá kvůli poplatku burzy a skluzu o něco nižší.
estimate.feeApiMoneyPoplatek partnera: u nákupu navíc k investici, u prodeje z hrubého výtěžku.
estimate.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.
estimate.fee.currencystringKód měny částky, například BTC nebo CZK.
estimate.totalApiMoney nebo nullNákup: investice plus poplatek partnera, částka k blokaci. U prodeje null. Pole je v odpovědi vždy.
estimate.total.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.
estimate.total.currencystringKód měny částky, například BTC nebo CZK.
estimate.netProceedsApiMoney nebo nullProdej: odhad výtěžku po poplatku partnera. U nákupu null. Pole je v odpovědi vždy.
estimate.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.
estimate.netProceeds.currencystringKód měny částky, například BTC nebo CZK.
estimate.minimumApiMoneyNejmenší pokyn vašeho partnerského účtu v Kč.
estimate.minimum.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.
estimate.minimum.currencystringKód měny částky, například BTC nebo CZK.
estimate.maximumApiMoney nebo nullNejvětší pokyn vašeho partnerského účtu v Kč, nebo null bez horní meze. Pole je v odpovědi vždy.
estimate.maximum.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.
estimate.maximum.currencystringKód měny částky, například BTC nebo CZK.
estimate.dailyLimitRemainingApiMoneyZbývající denní limit klienta pro dnešek (pražský čas) před tímto pokynem v Kč; počítají se i pokyny čekající na potvrzení.
estimate.dailyLimitRemaining.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.
estimate.dailyLimitRemaining.currencystringKód měny částky, například BTC nebo CZK.
codestring nebo nullKód chyby, se kterým by zadání skončilo, z katalogu chyb, nebo null, když je valid true. Pole je v odpovědi vždy.
detailstring nebo nullPopis chyby pro člověka, nebo null, když je valid true. Pole je v odpovědi vždy.
errorspole PublicApiOrderFieldIssue nebo nullVadná pole pokynu, každé s kódem; jen u kódu INVALID_ORDER, jinak null. Pole je v odpovědi vždy.
errors[].fieldstring nebo nullNázev pole požadavku, které je chybné, nebo null, když se problém týká pokynu jako celku. Pole je v odpovědi vždy.
errors[].codestringStrojově čitelný důvod, proč pole není platné, například REQUIRED nebo INVALID_VALUE.

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ší

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.
404CLIENT_NOT_FOUNDOvěřte externalClientRef včetně velikosti písmen; neexistující, cizí i zamítnutý subúčet vracejí stejnou chybu. Subúčet založte přes POST /v1/subaccounts.
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.
429RATE_LIMIT_EXCEEDEDPřed dalším pokusem vyčkejte počet sekund z Retry-After.
503MARKET_DATA_UNAVAILABLE, SERVICE_MAINTENANCE, PRICING_UNAVAILABLEData dočasně chybí; vyčkejte počet sekund z Retry-After a požadavek zopakujte. Probíhá údržba nebo je dočasně vypnuté obchodování či WebSocket; ověřte GET /v1/status a vyčkejte podle Retry-After. Nic se nezměnilo; požadavek zopakujte za chvíli. Čekající pokyn lze potvrdit znovu do konce lhůty.