Browse documentation
Get started
Inspect account capacity, respond to rate limits and track completed work.
On this page
Check your limits
Limits follow your account and plan. Run this free check with the key that will submit the work; all keys on the account share the same capacity.
Use your saved CLI access. For a named profile, append --profile NAME to each command. These reads do not spend query credits.
flashdata account limitsRequires Bash and cURL 7.76+. Skip the hidden key prompt if your environment already supplies FLASHDATA_API_KEY. Run the read commands in the same terminal.
# Bash: paste the key into a hidden prompt, not into this command.
read -r -s -p "FlashData API key: " FLASHDATA_API_KEY
printf '\n'
export FLASHDATA_API_KEY(
: "${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY first}"
curl --fail-with-body --silent --show-error --max-time 20 \
--header "X-API-Key: $FLASHDATA_API_KEY" \
'https://api.flashdata.dev/v2/api-access/limits' || exit
printf '\n'
)Skip the hidden key prompt if FLASHDATA_API_KEY is already set. Run the read commands in the same terminal.
# PowerShell 7: paste the key into a hidden prompt.
$flashdataSecureKey = Read-Host "FlashData API key" -AsSecureString
$env:FLASHDATA_API_KEY = [System.Net.NetworkCredential]::new("", $flashdataSecureKey).Password
Remove-Variable flashdataSecureKey& {
$ErrorActionPreference = 'Stop'
if ([string]::IsNullOrWhiteSpace($env:FLASHDATA_API_KEY)) {
throw 'Set FLASHDATA_API_KEY first'
}
$flashdataHeaders = @{ 'X-API-Key' = $env:FLASHDATA_API_KEY }
$flashdataBase = 'https://api.flashdata.dev/v2'
$flashdataUri = "$flashdataBase/api-access/limits"
Invoke-RestMethod -Uri $flashdataUri `
-Headers $flashdataHeaders -TimeoutSec 20 -MaximumRedirection 0 |
ConvertTo-Json -Depth 20
}Understand each limit
Start with one in-flight request, then increase within reported limits. HTTP read endpoints and trial registration also have their own rate limits; these capacity fields are not requests-per-minute quotas.
| Field | Meaning |
|---|---|
| limits.concurrency | Plan ceiling for simultaneous work, not a count of free slots. |
| limits.batchSize | Maximum items in one batch submission. |
| limits.pendingJobs | Maximum pending jobs for the account. |
| current.pendingJobs | Pending count at the time of the read. It can change before submission. |
Handle a 429 response
Read the error body and Retry-After header. To inspect a free account read, run this in a Bash terminal where FLASHDATA_API_KEY is set. Headers are written to limits-headers.txt and the response to limits.json.
curl --silent --show-error --max-time 20 \
--header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY first}" \
--dump-header limits-headers.txt --output limits.json \
--write-out 'HTTP %{http_code}\n' \
https://api.flashdata.dev/v2/api-access/limits
cat limits-headers.txt limits.jsonWait before retrying
This example means wait at least 60 seconds. Retry-After can also be an HTTP date. Use the returned value, not a fixed delay.
HTTP/1.1 429 Too Many Requests
Retry-After: 60Choose the next action
| Situation | Action |
|---|---|
| Capacity full | Reduce concurrency or wait for pending jobs to finish. |
| No Retry-After | Use capped backoff with jitter and a finite retry limit. |
| Registration limited | Wait, then retry with the same profile, input and proof. Do not switch IPs. |
| Submission timed out | Inspect the existing run or job before resubmitting; its outcome is unknown. |
Read account usage
The default window is the last seven days. Usage covers all account keys, restricted to the sources this key can access.
Use your saved CLI access. For a named profile, append --profile NAME to each command. These reads do not spend query credits.
flashdata account usageReuse FLASHDATA_API_KEY from the earlier check in the same terminal.
(
: "${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY first}"
curl --fail-with-body --silent --show-error --max-time 20 \
--header "X-API-Key: $FLASHDATA_API_KEY" \
'https://api.flashdata.dev/v2/usage' || exit
printf '\n'
)Reuse FLASHDATA_API_KEY from the earlier check in the same terminal.
& {
$ErrorActionPreference = 'Stop'
if ([string]::IsNullOrWhiteSpace($env:FLASHDATA_API_KEY)) {
throw 'Set FLASHDATA_API_KEY first'
}
$flashdataHeaders = @{ 'X-API-Key' = $env:FLASHDATA_API_KEY }
$flashdataBase = 'https://api.flashdata.dev/v2'
$flashdataUri = "$flashdataBase/usage"
Invoke-RestMethod -Uri $flashdataUri `
-Headers $flashdataHeaders -TimeoutSec 20 -MaximumRedirection 0 |
ConvertTo-Json -Depth 20
}Check completed work and credits
Read totals and bySource, then compare from and to with your task records. CLI JSON wraps the response in data. Recent requests or refunds can take time to appear, even when updating is false.
{
"scope": "account_authorized_sources",
"unit": "Credits",
"totals": {
"requests": 5,
"completed": 5,
"failed": 0,
"credits": 0.1
}
}Filter a source and date range
Replace the UTC dates with your reporting period, up to 31 days. from is inclusive and to is exclusive; both are rounded down to minutes. This reads existing usage only.
flashdata account usage --source google_search --from "2026-11-01T00:00:00Z" --to "2026-11-04T00:00:00Z"