API reference · Keys

Create a key

POSThttps://payday.direct/api/v1/keys

Makes a key and shows it once. Without a sign-in the request must be JSON and the key reads data only. launch: true needs a signed-in account.

No API key. Uses your payday.direct sign-in.

Body

labelstring

A name for the key

purposestring

What it is for (optional)

launchbooleandefault false

Allow this key to launch coins. Needs a signed-in account.

Responses

201Created

403A launch key without a sign-in

415Not sent as JSON

429Too many new keys

const res = await fetch("https://payday.direct/api/v1/keys", { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "label": "My terminal", "purpose": "Show fee recipients in my terminal", "launch": false }), }); const json = await res.json(); if (!res.ok) throw new Error(json.error?.code); console.log(json);

import os, requests r = requests.post( "https://payday.direct/api/v1/keys", json={ "label": "My terminal", "purpose": "Show fee recipients in my terminal", "launch": False }, ) r.raise_for_status() print(r.json())

{ "id": "pd_aB3dE9xQ", "key": "pd_aB3dE9xQ...SHOWN_ONCE", "label": "My terminal", "status": "active", "limit_per_minute": 600, "can_launch": false, "signed_in": false, "note": "Copy this key now. It is shown only once." }