Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.dojifunded.com/llms.txt

Use this file to discover all available pages before exploring further.

API keys are minted through the wallet-service (doji-auth-backend/apps/wallet-service). You can create them from the dashboard’s Developer page or directly over HTTP.

​
Key format

doji_ak_a3f2b1c9d8e7…   ← public key  →  sent in X-API-Key header
doji_sk_5b2a8f4c1e9d…   ← secret      →  sent in X-API-Secret header (never logged)
Both values are SHA-256 hashed at rest. The raw secret is returned only once at creation — save it immediately or revoke and regenerate.

​
Endpoints

These endpoints use the wallet-service base URL, not the trading engine.

​
List keys

GET https://api.dojifunded.com/api/api-keys

curl https://api.dojifunded.com/api/api-keys \
  -H "X-User-Id: $USER_ID"
Returns all active keys for the user (without secrets).

​
Create a key

POST https://api.dojifunded.com/api/api-keys

curl -X POST https://api.dojifunded.com/api/api-keys \
  -H "X-User-Id: $USER_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "label":       "my-bot-prod",
    "permissions": ["TRADE", "READ_ONLY"],
    "ipWhitelist": ["203.0.113.42"],
    "webhookUrl":  "https://my-bot.example.com/hooks/doji",
    "expiresAt":   "2027-01-01T00:00:00Z"
  }'
​
label
string
required
Human-readable name for the key.
​
permissions
string[]
required
One or more permission scopes. See Permission scopes below.
​
ipWhitelist
string[]
Optional list of allowed source IPs. Requests from other IPs return 403.
​
webhookUrl
string
Optional HTTPS URL to receive trade lifecycle events. Must start with https://.
​
expiresAt
string
Optional ISO 8601 expiry timestamp (must be in the future).
Response 
{
  "apiKey": {
    "id":          "…",
    "keyPrefix":   "doji_ak_a3f2b1c9",
    "permissions": ["TRADE", "READ_ONLY"]
  },
  "key":    "doji_ak_<48-char hex>",
  "secret": "doji_sk_<48-char hex>"
}
The secret field appears once in this response and never again. Copy it to a secrets manager before the request completes.
Constraints
  • Maximum 10 active keys per user — revoke before creating an 11th.
  • webhookUrl must use https://.
  • expiresAt must be an ISO 8601 timestamp in the future.

​
Revoke a key

DELETE https://api.dojifunded.com/api/api-keys/:id

curl -X DELETE https://api.dojifunded.com/api/api-keys/<keyId> \
  -H "X-User-Id: $USER_ID"
Revocation is immediate and unrecoverable.

​
Permission scopes

ScopeGrants access to
READ_ONLYAll GET endpoints — account, positions, market data
TRADEPOST /v1/order, close-position
MANAGE_ORDERSCancel orders, modify TP/SL, full order management
You can grant multiple scopes on a single key: ["TRADE", "READ_ONLY"].

​
Authenticating requests

Send both headers on every /v1/* call: 
X-API-Key:    doji_ak_a3f2b1c9d8e7…
X-API-Secret: doji_sk_5b2a8f4c1e9d…
Content-Type: application/json
The engine validates each request by calling POST /api/api-keys/validate against the wallet-service. Validation checks:
  • Key exists and is active
  • Secret hash matches
  • Key has not expired
  • Source IP is in ipWhitelist (if configured)
  • Key permissions cover the endpoint being called
Testnet caveat: current testnet endpoints accept calls without headers while enforcement is being wired at the gateway. Build your client with headers attached from day one — production will return 401 without them.
Store credentials as environment variables rather than hardcoding them: 
export DOJI_API_KEY="doji_ak_…"
export DOJI_API_SECRET="doji_sk_…"
export DOJI_ACCOUNT_ID="5e1c7a40-…"
Then reference them in requests: 
curl "$BASE/account/$DOJI_ACCOUNT_ID/summary" \
  -H "X-API-Key: $DOJI_API_KEY" \
  -H "X-API-Secret: $DOJI_API_SECRET"