Get Source Access Policy

curl --request GET \
  --url https://data-api.sovfixer.com/api/v1/limits \
  --header 'Authorization: <api-key>'

{
  "scope": "user",
  "subject": "alice@example.com",
  "allowlist": {
    "mode": "restricted",
    "source": "user",
    "sources": [
      "GG",
      "TD",
      "HH",
      "PH"
    ]
  },
  "sources": {
    "GG": {
      "limits": {
        "daily": 500,
        "monthly": 10000
      },
      "usage": {
        "daily": 42,
        "monthly": 6700
      },
      "remaining": {
        "daily": 458,
        "monthly": 3300
      }
    },
    "PH": {
      "limits": {
        "monthly": 1000
      },
      "usage": {
        "monthly": 312
      },
      "remaining": {
        "monthly": 688
      }
    }
  }
}

Usage

Get Source Access Policy

Returns the effective source access policy for a user or organization. The policy has two facets:

allowlist — which sources may be called at all. mode is restricted (only the listed sources are callable) or unrestricted (no gate). For user-scope queries the allowlist cascades: User.allowed_sources wins if set, otherwise Organization.allowed_sources applies; source tells you which level the allowlist came from.
sources — per-source quota state. Only sources with at least one cap appear here. For user-scope queries, caps stack: when both user and org cap a source, the lower cap wins per window. Windows are calendar-aligned in UTC: daily since 00:00 UTC today; monthly since 00:00 UTC on the 1st of the current month.

To decide if N locations of source X may be called: (1) if allowlist.mode == 'restricted' and X not in allowlist.sources, denied; (2) if sources[X].remaining[window] < N for any window, denied; otherwise allowed.

GET

api

limits

Get Source Access Policy

curl --request GET \
  --url https://data-api.sovfixer.com/api/v1/limits \
  --header 'Authorization: <api-key>'

{
  "scope": "user",
  "subject": "alice@example.com",
  "allowlist": {
    "mode": "restricted",
    "source": "user",
    "sources": [
      "GG",
      "TD",
      "HH",
      "PH"
    ]
  },
  "sources": {
    "GG": {
      "limits": {
        "daily": 500,
        "monthly": 10000
      },
      "usage": {
        "daily": 42,
        "monthly": 6700
      },
      "remaining": {
        "daily": 458,
        "monthly": 3300
      }
    },
    "PH": {
      "limits": {
        "monthly": 1000
      },
      "usage": {
        "monthly": 312
      },
      "remaining": {
        "monthly": 688
      }
    }
  }
}

Authorizations

Authorization

string

header

required

Token-based authentication with required prefix "Token"

Query Parameters

org_short_name

string

Filter by organization short name (e.g. 'AMWNS'). Staff only. Mutually exclusive with username.

username

string

Filter by this username. Defaults to the requesting user. Staff only when querying another user.

Response

scope

enum<string>

required

Available options:

user,

org

subject

string

required

allowlist

object

required

Show child attributes

sources

object

required

Per-source quota state. Sources with no cap are omitted.

Show child attributes

Get Datasource

Get Usage

⌘I

Documentation Index

Authorizations

Query Parameters

Response