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
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
| Parametr | Popis |
|---|---|
| externalClientRefpovinnéstring | Identifiká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 · PlaceSubaccountOrderBodyPodepiš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é.
| Pole | Popis |
|---|---|
| symbolpovinnéstring | Symbol 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éstring | buy nebo sell z pohledu základní měny trhu. Jen malými písmeny. Hodnoty: buy, sell. |
| typepovinnéstring | market. Jiný typ vrací ORDER_TYPE_NOT_ALLOWED. Hodnoty: market, limit. |
| quantityvolitelnéstring | Prodej: 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éstring | Ná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éboolean | Prodej: true prodá celou dostupnou pozici; quantity se pak neposílá. |
| clientOrderIdvolitelnéstring | Váš 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 · PartnerValidateOrderResponseOdhad 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.
| Pole | Popis |
|---|---|
| validboolean | True, když by zadání pokynu s tímto tělem teď prošlo. |
| estimatePartnerOrderEstimateResponse nebo null | Odhad pokynu, nebo null, když je valid false. Pole je v odpovědi vždy. |
| estimate.symbolstring | Symbol trhu, jak jste ho zadali. |
| estimate.sidestring | Strana pokynu. Hodnoty: buy, sell. |
| estimate.pricestring | Cena 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.quantitystring | Nákup: horní odhad získaného množství (investice děleno cenou). Prodej: prodávané množství. |
| estimate.quantityIsUpperEstimateboolean | True u nákupu: skutečně naplněné množství bývá kvůli poplatku burzy a skluzu o něco nižší. |
| estimate.feeApiMoney | Poplatek 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.currencystring | Kód měny částky, například BTC nebo CZK. |
| estimate.totalApiMoney nebo null | Ná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.currencystring | Kód měny částky, například BTC nebo CZK. |
| estimate.netProceedsApiMoney nebo null | Prodej: 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.currencystring | Kód měny částky, například BTC nebo CZK. |
| estimate.minimumApiMoney | Nejmenší 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.currencystring | Kód měny částky, například BTC nebo CZK. |
| estimate.maximumApiMoney nebo null | Nejvě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.currencystring | Kód měny částky, například BTC nebo CZK. |
| estimate.dailyLimitRemainingApiMoney | Zbý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.currencystring | Kód měny částky, například BTC nebo CZK. |
| codestring nebo null | Kó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 null | Popis chyby pro člověka, nebo null, když je valid true. Pole je v odpovědi vždy. |
| errorspole PublicApiOrderFieldIssue nebo null | Vadná 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 null | Ná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[].codestring | Strojově č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í.
| 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ší |
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 | CLIENT_NOT_FOUND | Ověř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. |
| 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. |
| 429 | RATE_LIMIT_EXCEEDED | Před dalším pokusem vyčkejte počet sekund z Retry-After. |
| 503 | MARKET_DATA_UNAVAILABLE, SERVICE_MAINTENANCE, PRICING_UNAVAILABLE | Data 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. |