- Live API Reference
- Account & Service Health
- Account, Plan & Usage
Account, Plan & Usage API
Your plan, daily request limit, usage today and when the quota resets.
Endpoint
Returns account details, plan, and usage quota for the authenticated user.
X-Api-Key)
Rate Limited: No
Plan: Free+
Parameters
This endpoint takes no parameters.
Request
curl -H "X-Api-Key: YOUR_API_KEY" \
https://lab.flashalpha.com/v1/accountimport requests
resp = requests.get(
"https://lab.flashalpha.com/v1/account",
headers={"X-Api-Key": "YOUR_API_KEY"}
)
resp.raise_for_status()
acct = resp.json()
print(f"Plan: {acct['plan']} | {acct['remaining']} of {acct['daily_limit']} left today")const resp = await fetch("https://lab.flashalpha.com/v1/account", {
headers: { "X-Api-Key": "YOUR_API_KEY" }
});
if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
const acct = await resp.json();
console.log(`Plan: ${acct.plan} | ${acct.remaining} of ${acct.daily_limit} left today`);Try it live
Runs on live market data and uses 1 request from your daily quota.
Response
{
"user_id": "d621e6ab-b4fc-4d62-86fc-08e489477e11",
"email": "[email protected]",
"plan": "alpha",
"daily_limit": "unlimited",
"usage_today": 0,
"remaining": "unlimited",
"resets_at": "2026-10-31T00:00:00Z",
"endpoint_version": "2026.09.30",
"data_as_of": {
"node": "fa4",
"equity_feed": "2026-10-30T13:45:27.902Z",
"equity_options_feed": "2026-10-30T13:45:26Z",
"index_feed": "2026-10-30T13:45:26.113Z",
"index_options_feed": "2026-10-30T13:45:25Z",
"futures_feed": "2026-10-30T13:45:26.817Z",
"futures_options_feed": "2026-10-30T13:45:17.77Z",
"flow_feed": "2026-10-30T13:45:00Z",
"oi_feed": "2026-10-29T20:00:00Z",
"macro_feed": "2026-10-29T21:00:20Z"
}
}Sending request…
See this endpoint on live data
Send this exact request and the real response shows up here, right next to the example.
Response Fields
| Field | Type | Description |
|---|---|---|
user_id |
string | User's unique identifier (GUID) |
email |
string | Account email address |
plan |
string | Plan name: free, basic, growth, alpha, enterprise |
daily_limit |
string | Daily request limit, or "unlimited" |
usage_today |
integer | Requests made today (always 0 for unlimited plans) |
remaining |
string | Requests remaining today, or "unlimited" |
resets_at |
string | ISO 8601 timestamp when the daily quota resets (midnight UTC) |
endpoint_version, data_as_of | string, object | Response envelope, see Response envelope. |
Errors
See Error Responses for the error body formats.
| Status | Error | When |
|---|---|---|
401 | - | Missing or invalid X-Api-Key. The body is empty; check the status code before parsing JSON. |
What Is the Account Endpoint?
The Account endpoint tells you which plan your API key is on and how much of today's request quota is left. Call it at startup to confirm the key works and the plan unlocks the endpoints you need, or before a batch job to make sure the job fits in the remaining quota. Plan limits are listed under Rate Limits & Plans.
Common Use Cases
- Verify a key at startup - fail fast on a bad or revoked key
- Budget batch jobs - check
remainingbefore a large run - Show usage in your app - display plan and quota to your own users
- Schedule around resets - use
resets_atto time heavy jobs
Related
Complementary endpoints
- Health Check - service status for monitoring
- Rate Limits & Plans - daily limits and rate-limit headers per plan
- Lab API Reference - field glossary and status codes