Get account
Balance, tier, monthly credit usage, and rate limits, for free.
GET
https://api.up2data.ai/v1/accountPoll it from dashboards and billing alerts as often as you like; this call is always free. credits_used_this_month is the net credits charged since the start of the calendar month, with refunds (such as an unused Sales Navigator search reservation) already subtracted. rate_limit reports the limits that apply to your organization, which can differ from the defaults in Rate limits. signals and monitoring report fixed defaults: Signals are not offered yet. The meta object on this response has no latencyMs.
#Request
No request body.
#Call it
curl -X GET "https://api.up2data.ai/v1/account" \
-H "X-API-Key: YOUR_API_KEY"import requests
url = "https://api.up2data.ai/v1/account"
headers = {
"X-API-Key": "YOUR_API_KEY",
}
response = requests.get(url, headers=headers)
print(response.json())const url = "https://api.up2data.ai/v1/account";
const headers = {
"X-API-Key": "YOUR_API_KEY",
};
const response = await fetch(url, {
method: "GET",
headers,
});
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.up2data.ai/v1/account"
req, err := http.NewRequest("GET", url, nil)
if err != nil {
panic(err)
}
req.Header.Set("X-API-Key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
respBody, _ := io.ReadAll(resp.Body)
fmt.Println(string(respBody))
}#Response
{
"data": {
"account_id": "64f1c2a9e4b0a1d2c3e4f5a6",
"tier": "growth",
"credits_remaining": 98413,
"credits_used_this_month": 41587,
"price_per_1k_credits_usd": 1.25,
"rate_limit": { "requests_per_minute": 300, "concurrent_batch_jobs": 100, "searches_per_hour": 20, "searches_remaining_this_hour": 17 },
"signals": { "active": 0, "paused": 0, "max_active": 5000, "estimated_monthly_credits": 0 },
"monitoring": { "default_webhook_url": null, "monthly_check_budget": 10000, "checks_spent_this_month": 0 }
},
"meta": { "creditsUsed": 0, "creditsRemaining": 98413, "billed": false, "reason": "success", "requestId": "req_ac10mmd2" }
}#Errors
| Status | Type | When | Billed |
|---|---|---|---|
| 401 | invalid_api_key | Missing, malformed, or revoked key. | No |
| 429 | rate_limited | Over the per-key requests/min limit. Honor Retry-After. | No |
| 500 | internal_error | Something broke on the server side. | No |
See the Errors guide for every error type this version can return.