API Key Usage

API Key Usage

curl --request GET \
  --url https://api.sorsa.io/v3/key-usage-info \
  --header 'ApiKey: <api-key>'

{
  "key_requests": 100,
  "remaining_requests": 100,
  "total_requests": 1000,
  "valid_until": "2021-01-01T00:00:00Z"
}

GET

key-usage-info

API Key Usage

curl --request GET \
  --url https://api.sorsa.io/v3/key-usage-info \
  --header 'ApiKey: <api-key>'

{
  "key_requests": 100,
  "remaining_requests": 100,
  "total_requests": 1000,
  "valid_until": "2021-01-01T00:00:00Z"
}

ApiKey

string

header

required

key_requests

integer

Number of requests allocated for the current period.

Example:

100

remaining_requests

integer

Number of requests remaining.

Example:

100

total_requests

integer

Total requests used across all periods.

Example:

1000

valid_until

string

Expiration date of the current request balance in ISO 8601 format.

Example:

"2021-01-01T00:00:00Z"

⌘I