Account
The Account API exposes the metadata associated with the authenticated API key: the owning user, organization, the scopes granted, and the remaining lookup quota.
Get account info
Requires BASIC and costs no credits.
Response
- Name
first_name- Type
- string
- Description
First name of the account owner.
- Name
last_name- Type
- string
- Description
Last name of the account owner.
- Name
email- Type
- string
- Description
Email address of the account owner.
- Name
organization- Type
- object
- Description
The organization the API key belongs to.
- Name
organization.id- Type
- string
- Description
Organization UUID.
- Name
organization.name- Type
- string
- Description
Display name of the organization.
- Name
organization.relation- Type
- string
- Description
Relationship of the user to the organization. One of
OWNER,ADMIN, orMEMBER.
- Name
scopes- Type
- array<string>
- Description
Scopes granted to the API key, such as
BASIC,PROXY_FIREHOSE, orANONYMIZERS_FEED. See the table below for the full list.
- Name
lookup_quota- Type
- object
- Description
Remaining lookup quota for the current billing period.
- Name
lookup_quota.credits- Type
- integer
- Description
Lookup credits remaining.
- Name
lookup_quota.resets_in- Type
- integer
- Description
Seconds until the credit balance resets.
- Name
api_key- Type
- object
- Description
The API key used for the request.
- Name
api_key.id- Type
- string
- Description
UUID identifying the key. It is not the secret.
- Name
api_key.name- Type
- string
- Description
Display name of the key.
- Name
api_key.created_at- Type
- string
- Description
RFC 3339 creation time, the one timestamp on the HTTP surface that is not a Unix integer.
Request
curl -G https://api.synthient.com/api/v4/account/me \
-H "x-api-key: $SYNTHIENT_API_KEY"
Response
{
"first_name": "Ada",
"last_name": "Lovelace",
"email": "ada@example.com",
"organization": {
"id": "0b6f3c1e-58a4-4d2b-9a57-2f1c8e9d4a10",
"name": "Analytical Engine, Inc.",
"relation": "OWNER"
},
"scopes": [
"BASIC",
"PROXY_FEEDS",
"PROXY_FIREHOSE",
"ANONYMIZERS_FEED"
],
"lookup_quota": {
"credits": 982341,
"resets_in": 1893456
},
"api_key": {
"id": "7c2d4e9a-1b3f-4a6c-8d0e-5f7a9b1c3d2e",
"name": "production",
"created_at": "2026-09-28T19:04:52.463869Z"
}
}
Scopes
The scopes array on the response lists which capabilities your API key has been granted. Each feed exposes two independent scopes: a *_FEED scope for the parquet-snapshot exports and a *_STREAM scope (or PROXY_FIREHOSE for proxies) for the real-time NDJSON stream.
| Scope | Grants |
|---|---|
BASIC | IP lookups: GET /api/v4/lookup/ip/{ip_address}, POST /api/v4/lookup/ips. Also required for GET /account/me. |
PROXY_FEEDS | proxies parquet exports (/api/v4/feeds/proxies/export*). |
PROXY_FIREHOSE | proxies real-time NDJSON stream. |
ANONYMIZERS_FEED | anonymizers parquet exports. |
ANONYMIZERS_STREAM | anonymizers real-time stream. |
TORRENTS_FEED / TORRENTS_STREAM | BitTorrent peer-observation exports / stream. |
HONEYPOT_HTTP_FEED / HONEYPOT_HTTP_STREAM | HTTP honeypot exports / stream. |
HONEYPOT_HTTPS_FEED / HONEYPOT_HTTPS_STREAM | TLS honeypot (ClientHello) exports / stream. |
HONEYPOT_DNS_FEED / HONEYPOT_DNS_STREAM | Helios tunnel destination exports / stream. |
HONEYPOT_ADB_FEED / HONEYPOT_ADB_STREAM | Android Debug Bridge honeypot exports / stream. |
GEOLOCATION_FEED | Geolocation dataset exports (Parquet, gzip CSV, and MMDB). |
WHOIS_FEED | WHOIS dataset exports. |
NETWORK_IOCS_FEED / NETWORK_IOCS_STREAM, FILE_IOCS_FEED / FILE_IOCS_STREAM, WHOIS_STREAM | Reserved for upcoming feeds. No endpoint accepts them yet. |
A request to an endpoint your key isn't scoped for returns 403 Forbidden. See Authentication for the full key-management model.