Skip to content
Screaming Data
Documentation menu

API reference

Appendix API

Free account and reference endpoints: balance, usage, keys, marketplaces, status.

Free endpoints for your account and for reference data: balance and rates, usage statistics, API keys, marketplaces, service status and the table of status codes.

Endpoints

Account object

Your account, balance, limits, rates, usage, active keys and webhook secret.

login
string

API login.

email
string

Account e-mail.

name
string· nullable

Contact name.

company
string· nullable

Company name.

plan
string

Plan name.

billing_mode
string

prepaid for accounts billed from a prepaid balance.

balance
number

Prepaid balance in USD.

currency
string

Balance currency, always USD.

rate_limits
object

Your limits: requests_per_minute, tasks_per_request, tasks_per_minute.

rates
array of objects

The rates that apply to your account: key, price (USD), currency, unit, endpoint, description. Keys are the API's price keys, for example amazon.product.live.

usage
object

Totals for today and this_month (UTC), each with requests, tasks and cost.

keys
array of objects

Active API keys: id, prefix, last4, label, created_at, last_used_at, revoked_at. Full keys are never returned again.

webhook_secret
string

Secret used to sign postbacks and pingbacks. See Webhooks.

created_at
string (date-time)

When the account was created, ISO 8601 in UTC.

Usage object

Usage between two dates, inclusive, in UTC.

date_from
string (date)

First day of the period.

date_to
string (date)

Last day of the period.

days
array of objects

One row per day of the period, oldest first, including days without usage: date, requests, tasks, cost.

endpoints
array of objects

Totals per endpoint for the period, most expensive first: endpoint (for example amazon/product/task_post), requests, tasks, cost.

totals
object

Totals for the period: requests, tasks, cost.

Marketplace object

A supported Amazon marketplace.

code
string

Code used in requests.

domain
string

Amazon domain.

name
string

Country name.

country_code
string

ISO 3166-1 alpha-2 country code.

currency
string

ISO 4217 currency of prices on this marketplace.

language
string

ISO 639-1 code of the main storefront language.

language_name
string

Name of that language.

aliases
array of strings

Other codes accepted on input.

Marketplace status

Health of one marketplace over the last 24 hours. Aggregated over all traffic; contains no data of other clients. Values are null when there is not enough recent data.

marketplace
string

Marketplace code.

domain
string

Amazon domain.

available
boolean· nullable

Whether product pages of this marketplace are being read successfully; null when there is not enough recent data.

status
string

operational (success rate at least 90%), degraded (at least 50%), unavailable or unknown.

success_rate_24h
number· nullable

Share of successful product reads in the last 24 hours, from 0 to 1.

fetches_24h
integer· nullable

Number of product page reads in the last 24 hours.

median_task_minutes_24h
number· nullable

Median time from task_post to completion in the last 24 hours, in minutes.

queue_depth
integer· nullable

Collection jobs currently waiting for this marketplace.

Status code

One row of the status code table.

status_code
integer

Status code.

status_message
string

Status message.

http_status
integer

HTTP status when the code is returned for the request as a whole.

description
string

When the code is returned.

New API key

The only response that contains the full key. Store it securely right away.

id
integer

Key id. Use it to revoke the key.

key
string

Full API key: sd_live_ followed by 40 URL-safe characters. Shown once.

prefix
string

First 12 characters, for display.

last4
string

Last 4 characters, for display.

label
string· nullable

Your label.

created_at
string (date-time)

Creation time, ISO 8601 in UTC.

last_used_at
string (date-time)· nullable

Always null for a new key.

revoked_at
string (date-time)· nullable

Always null for a new key.

Revoked API key

The key after revocation.

id
integer

Key id.

prefix
string

First 12 characters of the key.

last4
string

Last 4 characters of the key.

label
string· nullable

Your label.

created_at
string (date-time)

Creation time, ISO 8601 in UTC.

last_used_at
string (date-time)· nullable

Last successful authentication with the key.

revoked_at
string (date-time)

Revocation time, ISO 8601 in UTC.