v4

Account

View as markdown

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/api/v4/account/me
Open in playground (opens in a new tab)

Get account info

Returns information about the authenticated account, including the owning user, organization, granted scopes, and the remaining lookup quota.

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

    Unique organization identifier.

  • 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, or MEMBER.

  • Name
    scopes
    Type
    array<string>
    Description

    Scopes granted to the API key, such as BASIC, PROXY_FIREHOSE, or ANONYMIZERS_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.

Request

GET/api/v4/account/me
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": "org_01J5XK2ZQ8R6VBT3WE6E7C9D2H",
    "name": "Analytical Engine, Inc.",
    "relation": "OWNER"
  },
  "scopes": [
    "BASIC",
    "PROXY_FEEDS",
    "PROXY_FIREHOSE",
    "ANONYMIZERS_FEED"
  ],
  "lookup_quota": {
    "credits": 982341,
    "resets_in": 1893456
  }
}

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.

ScopeGrants
BASICIP and domain lookups: GET /api/v4/lookup/ip/{ip}, POST /api/v4/lookup/ips, GET /api/v4/lookup/domain/{domain}. Also required for GET /account/me.
PROXY_FEEDSproxies parquet exports (/api/v4/feeds/proxies/export*).
PROXY_FIREHOSEproxies real-time NDJSON stream.
ANONYMIZERS_FEEDanonymizers parquet exports.
ANONYMIZERS_STREAManonymizers real-time stream.
TORRENTS_FEED / TORRENTS_STREAMBitTorrent peer-observation exports / stream.
HONEYPOT_HTTP_FEED / HONEYPOT_HTTP_STREAMHTTP honeypot exports / stream.
HONEYPOT_HTTPS_FEED / HONEYPOT_HTTPS_STREAMTLS honeypot (ClientHello) exports / stream.
HONEYPOT_DNS_FEED / HONEYPOT_DNS_STREAMDNS honeypot exports / stream.
HONEYPOT_ADB_FEED / HONEYPOT_ADB_STREAMAndroid Debug Bridge honeypot exports / stream.

A request to an endpoint your key isn't scoped for returns 403 Forbidden. See Authentication for the full key-management model.