Quickstart
This guide walks you through authentication and your first API call in under 5 minutes.
Prerequisites
- An Aark account (free Explorer plan or above)
- Your API key, available in the dashboard after sign-in
- curl or any HTTP client (Python requests, Node fetch, etc.)
Step 1 — Get your API key
After signing in at aarkdigital.org/login, navigate to Settings → API Keys and create a new key. Copy it — it won't be shown again.
Keys are prefixed ark_live_ for production environments.
Step 2 — Make your first call
The simplest call fetches the current funding rate for BTC-PERP:
curl -X GET "https://aarkdigital.org/api/v1/funding-rates?pair=BTC-PERP" \
-H "Authorization: Bearer ark_live_YOUR_API_KEY"
Step 3 — Parse the response
A successful response returns JSON with the normalized funding rate, signal direction, and oracle metadata:
{
"pair": "BTC-PERP",
"funding_rate": 0.000142,
"interval": "8h",
"annualized": 0.0619,
"signal": "LONG_BIAS",
"oracle_lag_ms": 118,
"timestamp": "2026-05-29T14:32:01Z",
"next_settlement": "2026-05-29T16:00:00Z"
}
Step 4 — Python example
import requests
API_KEY = "ark_live_YOUR_API_KEY"
BASE = "https://aarkdigital.org/api/v1"
resp = requests.get(
f"{BASE}/funding-rates",
params={"pair": "BTC-PERP"},
headers={"Authorization": f"Bearer {API_KEY}"},
)
data = resp.json()
print(f"BTC-PERP funding rate: {data['funding_rate']:.6%}")
print(f"Signal: {data['signal']}")
Next steps
- API Reference — all endpoints and parameters
- Webhooks — configure threshold alerts
- Upgrade plan — higher rate limits and 90-day history