Skipanalína (CLI)

Uppsetning#

npm install -g @myntkaup/cli
myntkaup --version

Það þarf Node.js 22.12 eða nýrra. Skipunin heitir myntkaup. Einnig má keyra npx @myntkaup/cli án þess að setja pakkann upp.

Innskráning#

Einfaldast er að gera það í vafranum:

myntkaup auth login --web

Skipanalínan opnar Stillingar → API og biður um kóða. Þar velur þú Tengja skipanalínuna, hvað lykillinn má gera, staðfestir með rafrænum skilríkjum og afritar einnota kóðann í skipanalínuna. Skipanalínan býr lyklaparið til á tölvunni þinni, svo einkalykillinn er aldrei sýndur né sendur neitt. Myntkaup biður aldrei neinn um þennan kóða: límdu hann aðeins inn í skipun sem þú keyrðir sjálf eða sjálfur.

Eða búðu sjálf eða sjálfur til lykil, eins og í Fyrstu skrefum, aðeins með þeim heimildum sem þú þarft, og gefðu skipanalínunni hann:

# The .env file Settings → API offered:
myntkaup auth login --env-file ~/Downloads/myntkaup-mk_live_….env

# Or type the key id and private key (the private key isn't shown):
myntkaup auth login --with-key

• Lykillinn er prófaður fyrst. Skipanalínan kallar á GET/v1/me með honum og vistar ekkert ef það mistekst.
• Einkalykillinn verður eftir á tölvunni þinni. Hann fer í lyklageymslu stýrikerfisins (Keychain á macOS, Credential Manager á Windows eða Secret Service á Linux). Þar sem engin lyklageymsla er til geymir --storage file hann í skrá sem aðeins notandinn þinn getur lesið. Skipanalínan neitar að nota skrána ef aðrir geta lesið hana.
• Eyddu niðurhalaðri skránni þegar hún hefur verið flutt inn.
• Prófílar: hver vistaður lykill er prófíll. Bættu fleirum við með --profile <heiti>, sjáðu þá með myntkaup auth list og veldu sjálfgefinn prófíl með myntkaup auth use <heiti>.
• myntkaup auth status sýnir lykilinn sem er í notkun, heimildir hans og gildistíma.
• myntkaup auth logout afturkallar lykil sem skipanalínan bjó til með --web, og gleymir honum. Lykill sem þú fluttir inn gæti verið í notkun annars staðar, svo honum er aðeins gleymt; bættu við --revoke til að afturkalla hann líka.

Hvert beiðnir fara. Raunlykill (mk_live_…) er aðeins sendur á https://public-api.myntkaup.is, sama hvað annað er stillt. Prófunarlykill (mk_test_…) fer sjálfgefið á prófunarumhverfið, eða með --base-url á aðra https slóð eða á slóð á þinni eigin tölvu. auth login --web hefur engan lykil til að fara eftir, svo hún tengist raunumhverfinu; til að tengja prófunarlykil bætir þú við --base-url https://public-api.staging.myntkaup.is.

Skipanir#

--usdc er upphæð í USDC; --amount er magn rafmyntarinnar. myntkaup <skipun> --help sýnir alla valkosti.

Viðskipti innan verðmarka#

Verðtilboð er bindandi í aðeins nokkrar sekúndur, of stutt til að lesa það og svara. Þess vegna vinna buy og sell öðruvísi en skrefin tvö í API-inu:

1. Þú staðfestir verðmörk

   Skipanalínan sýnir leiðbeinandi verð, um það bil hvað þú færð eða greiðir, og verðmörk: sjálfgefið 0,5% verra en leiðbeinandi verðið. Stilltu þau með --max-price (kaup) eða --min-price (sala), eða breyttu bilinu með --max-slippage. Staðfestingin nefnir líka aðganginn og lykilinn, svo þú vitir hvers peningar þetta eru.

2. Hún biður um verðtilboð og samþykkir strax

   Skipanalínan biður um verðtilboð með POST/v1/quotes. Hún samþykkir það með POST/v1/trades aðeins ef verðið er innan markanna og upphæðin er sú sem þú baðst um. Ef verðtilboðið rennur út eða verðið hreyfist biður hún um nýtt, mest tvisvar, innan sömu marka.

3. Hún fylgist með viðskiptunum

   Fylgst er með viðskiptum í bið í allt að 30 sekúndur (--wait). Ef svarið við beiðninni týnist les skipanalínan verðtilboðið til að sjá hvort það var samþykkt, í stað þess að reyna aftur.

--dry-run biður um verðtilboð og kannar það, án þess að samþykkja það.

Í skriftum og CI#

export MYNTKAUP_API_KEY_ID=mk_live_…
export MYNTKAUP_API_PRIVATE_KEY=mk_sk_…
myntkaup balances --json | jq -r '.data[] | "\(.asset) \(.available)"'
myntkaup buy BTC --usdc 25 --yes --json | jq -r .id

• Lykillinn úr umhverfinu: þegar báðar breyturnar eru stilltar notar skipanalínan þær og vistar ekkert. Notaðu sér lykil fyrir hverja vél, aðeins með þeim heimildum sem hún þarf.
• Staðfestingar: allt sem hreyfir peninga spyr fyrst. Þar sem skipanalínan getur ekki spurt stöðvast hún nema þú bætir við --yes. Verðmörkin gilda líka með --yes.
• Úttak: --json prentar JSON svar API-sins á stdout, eins og í API lýsingunni. Spurningar, athugasemdir og villur fara á stderr. Kóðar gjafabréfa eru faldir nema þú bætir við --show-code.
• Listar: --all sækir allar síður (síðuskipting).
• Endurtekningar: --idempotency-key á viðskiptum, gjafabréfum og úttektum gerir það öruggt að endurtaka sömu skipun (endurtekningar).

Stöðukóðar við lok keyrslu:

Villukóðunum fylgja skilaboð API-sins og auðkenni beiðninnar, og ábending þar sem eitthvað er hægt að gera.

Stillingar#

Aðrir almennir valkostir: --no-input (spyrja aldrei), --verbose (skrá hverja beiðni á stderr, aldrei undirskrift hennar) og --timeout <sekúndur>.