API lýsing · Viðskipti

Samþykkja verðtilboð

POST/v1/trades

Framkvæmir opið verðtilboð. Skilar 201 þegar viðskiptunum er lokið, eða 202 meðan þau eru enn í bið; fylgstu þá með þeim í GET /v1/trades/{id}. Hafnað með price_moved ef markaðurinn hefur hreyfst gegn verðtilboðinu meira en vikmörk aðgangsins leyfa. Idempotency-Key er skylda: ef beiðnin rennur út á tíma, reyndu aftur með sama lykli.

Heimild
trade
Takmarkaflokkur
trade
Auðkenning
Undirrituð
Idempotency-Key
Skylda

Færibreytur

  • Idempotency-Keystringhausskylda

    1 til 64 stafir úr [A-Za-z0-9_-]. Geymdur í 24 klst.; notaðu hann aftur til að endurtaka beiðni á öruggan hátt.

    Passar við ^[A-Za-z0-9_-]{1,64}$.

Meginmál beiðnar

application/json · CreateTradeRequest. Óþekktum reitum er hafnað.

  • quote_idstringskylda

    Byrjar á qt_. Dæmi: qt_01JB8X2Q4M7Z3V9K5T1N6R0P2W.

Svör

201 Created

Viðskiptin, framkvæmd eða misheppnuð. application/json · Trade

  • idstring

    Byrjar á tr_.

  • quote_idstringgetur verið null

    null fyrir viðskipti sem voru gerð áður en verðtilboð komu til.

    Byrjar á qt_.

  • assetstring

    Tákn rafmyntar, í hástöfum.

    Passar við ^[A-Z0-9]{1,15}$.

  • sidestring (enum)

    Eitt af buy, sell.

  • quote_currency"USDC"
  • base_amountstring (tugatala)
  • quote_amountstring (tugatala)
  • pricestring (tugatala)
  • statusstring (enum)

    Eitt af pending, filled, failed.

  • sourcestring (enum)

    Hvar færslan varð til: í þessu API, í appinu eða í vefappinu.

    Eitt af public_api, app, web.

  • created_atstring (date-time)
  • filled_atstring (date-time)getur verið null
  • failure_reasonstring | null

202 Accepted

Viðskiptin, enn í bið. application/json · Trade

  • idstring

    Byrjar á tr_.

  • quote_idstringgetur verið null

    null fyrir viðskipti sem voru gerð áður en verðtilboð komu til.

    Byrjar á qt_.

  • assetstring

    Tákn rafmyntar, í hástöfum.

    Passar við ^[A-Z0-9]{1,15}$.

  • sidestring (enum)

    Eitt af buy, sell.

  • quote_currency"USDC"
  • base_amountstring (tugatala)
  • quote_amountstring (tugatala)
  • pricestring (tugatala)
  • statusstring (enum)

    Eitt af pending, filled, failed.

  • sourcestring (enum)

    Hvar færslan varð til: í þessu API, í appinu eða í vefappinu.

    Eitt af public_api, app, web.

  • created_atstring (date-time)
  • filled_atstring (date-time)getur verið null
  • failure_reasonstring | null

Öll svör bera MK-Request-Id, auk RateLimit-Policy og RateLimit.

Villur

Villur nota villuumslagið. Greindu þær eftir code.

StaðaKóðiMerking
400invalid_requestBeiðnin er gölluð: ógilt JSON, óþekktur eða ógildur reitur, eða haus vantar.
401invalid_signatureMK-* hausana vantar eða þeir eru gallaðir, auðkenni lykilsins er óþekkt eða undirskriftin passar ekki.
401key_expiredGildistími lykilsins er liðinn.
401key_revokedLykillinn var afturkallaður.
401timestamp_out_of_rangeMK-Timestamp munar meira en 30 sekúndum frá klukku netþjónsins.
401nonce_reusedÞessi lykill hefur þegar notað þetta MK-Nonce.
403ip_not_allowedBeiðnin kom frá IP tölu sem er ekki meðal leyfðra IP talna lykilsins.
403insufficient_scopeLykilinn vantar heimildina sem þessi endapunktur þarf.
403account_restrictedAðgangurinn getur ekki notað API-ið eins og er (til dæmis læstur, óvirkur eða nýskráningu ólokið).
403api_access_disabledSlökkt er á aðgangi að API-inu.
404not_foundÞetta fannst ekki.
409idempotency_conflictÞessi Idempotency-Key var notaður með öðru meginmáli.
409idempotency_in_progressBeiðni með þessum Idempotency-Key er enn í vinnslu.
409quote_already_usedVerðtilboðið hefur þegar verið samþykkt.
413payload_too_largeMeginmál beiðnarinnar er stærra en 8 KB.
415unsupported_media_typeMeginmál beiðna verður að vera application/json.
422quote_expiredVerðtilboðið er útrunnið.
422price_movedMarkaðsverðið hreyfðist of langt frá verðinu í tilboðinu.
422insufficient_fundsLaus innistæða dugar ekki fyrir viðskiptunum, gjafabréfinu eða úttektinni.
422limit_exceededFarið yrði yfir dagleg mörk eða 30 daga mörk.
422asset_not_tradableEkki er hægt að eiga viðskipti með rafmyntina eins og er.
429rate_limitedOf margar beiðnir. Bíddu í Retry-After sekúndur.
429too_many_concurrent_requestsOf margar beiðnir í vinnslu í einu fyrir þennan lykil eða aðgang.
429key_suspendedLykillinn er stöðvaður, til dæmis eftir að hafa farið ítrekað yfir beiðnatakmörk.
500internal_errorEitthvað fór úrskeiðis hjá okkur.
502bad_gatewayUndirliggjandi þjónusta svaraði á óvæntan hátt.
503overloadedÞjónustan er undir of miklu álagi. Reyndu aftur eftir Retry-After sekúndur.
503service_unavailableÞjónustan er tímabundið ekki tiltæk.
503maintenanceVegna viðhalds er aðeins hægt að lesa úr API-inu.
503trading_haltedViðskipti eru í hléi: slökkt hefur verið á þeim, eða gert hlé á viðskiptum með rafmyntina í stutta stund eftir snögga verðhreyfingu.
504gateway_timeoutUndirliggjandi þjónusta svaraði ekki í tæka tíð. POST beiðni gæti samt klárast; reyndu aftur með sama Idempotency-Key.

Beiðni

# Signed by sign-headers.sh: see Authentication
body='{"quote_id":"qt_01JB8X2Q4M7Z3V9K5T1N6R0P2W"}'
idempotency_key=$(uuidgen)   # reuse it to retry safely
curl https://public-api.myntkaup.is/v1/trades \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $idempotency_key" \
  $(./sign-headers.sh POST /v1/trades "$body" | sed 's/^/-H /') \
  --data "$body"
import { Myntkaup } from "@myntkaup/api";

const client = new Myntkaup(); // reads the key from the environment
// Sends a random Idempotency-Key unless you pass idempotencyKey.
const trade = await client.trades.create({ quoteId: "qt_01JB8X2Q4M7Z3V9K5T1N6R0P2W" });
console.log(trade.status, trade.base_amount);
from myntkaup import Myntkaup

client = Myntkaup()  # reads the key from the environment
# Sends a random Idempotency-Key unless you pass idempotency_key.
trade = client.trades.create(quote_id="qt_01JB8X2Q4M7Z3V9K5T1N6R0P2W")
print(trade["status"], trade["base_amount"])

Svar

201 Created
{
  "id": "tr_01JB8X2Q4M7Z3V9K5T1N6R0P2W",
  "quote_id": "qt_01JB8X2Q4M7Z3V9K5T1N6R0P2W",
  "asset": "BTC",
  "side": "buy",
  "quote_currency": "USDC",
  "base_amount": "0.00104210",
  "quote_amount": "100.00",
  "price": "95960.12",
  "status": "filled",
  "source": "public_api",
  "created_at": "2026-11-03T10:15:12Z",
  "filled_at": "2026-11-03T10:15:13Z",
  "failure_reason": null
}
202 Accepted
{
  "id": "tr_01JB8X2Q4M7Z3V9K5T1N6R0P2W",
  "quote_id": "qt_01JB8X2Q4M7Z3V9K5T1N6R0P2W",
  "asset": "BTC",
  "side": "buy",
  "quote_currency": "USDC",
  "base_amount": "0.00104210",
  "quote_amount": "100.00",
  "price": "95960.12",
  "status": "pending",
  "source": "public_api",
  "created_at": "2026-11-03T10:15:12Z",
  "filled_at": null,
  "failure_reason": null
}

Grunnslóð https://public-api.myntkaup.is