Skip to content
Screaming Data
Documentation menu

Appendix API

Service status

Status of every marketplace.

GET
https://api.screamingdata.dev/v1/appendix/status
Authentication
Optional
Cost
Free
Body
No request body

Overview

Returns the current status of every marketplace: whether it is available, and its status. Values are aggregated over all traffic and contain no data of other clients.

An API key is optional, so the public status page reads this endpoint directly. available is null while there is not enough recent data.

Cost

Free.

Request

GET /v1/appendix/status.

This endpoint takes no parameters.

Request example

An API key is optional for this endpoint, so the examples omit it. Requests that send one are metered like any other call.

curl --request GET \
  --url "https://api.screamingdata.dev/v1/appendix/status"

Response

HTTP 200. The body is the standard response envelope; check status_code at the top level and in every task.

Response example
{
  "version": "1.0.0",
  "status_code": 20000,
  "status_message": "Ok.",
  "time": "0.0185 sec.",
  "cost": 0,
  "tasks_count": 1,
  "tasks_error": 0,
  "tasks": [
    {
      "id": "09241253-8f1b-4e5d-a2c7-4b9e0d3f6a18",
      "status_code": 20000,
      "status_message": "Ok.",
      "time": "0.0097 sec.",
      "cost": 0,
      "result_count": 12,
      "path": [
        "v1",
        "appendix",
        "status"
      ],
      "data": {
        "api": "appendix",
        "function": "status"
      },
      "result": [
        {
          "marketplace": "com",
          "domain": "amazon.com",
          "available": true,
          "status": "operational"
        },
        {
          "marketplace": "uk",
          "domain": "amazon.co.uk",
          "available": true,
          "status": "operational"
        },
        {
          "marketplace": "de",
          "domain": "amazon.de",
          "available": true,
          "status": "operational"
        },
        {
          "marketplace": "fr",
          "domain": "amazon.fr",
          "available": true,
          "status": "operational"
        },
        {
          "marketplace": "es",
          "domain": "amazon.es",
          "available": true,
          "status": "operational"
        },
        {
          "marketplace": "it",
          "domain": "amazon.it",
          "available": true,
          "status": "operational"
        },
        {
          "marketplace": "nl",
          "domain": "amazon.nl",
          "available": true,
          "status": "operational"
        },
        {
          "marketplace": "ca",
          "domain": "amazon.ca",
          "available": true,
          "status": "operational"
        },
        {
          "marketplace": "au",
          "domain": "amazon.com.au",
          "available": true,
          "status": "operational"
        },
        {
          "marketplace": "jp",
          "domain": "amazon.co.jp",
          "available": true,
          "status": "degraded"
        },
        {
          "marketplace": "mx",
          "domain": "amazon.com.mx",
          "available": null,
          "status": "unknown"
        },
        {
          "marketplace": "in",
          "domain": "amazon.in",
          "available": false,
          "status": "unavailable"
        }
      ]
    }
  ]
}

Result fields

Each element of tasks[].result is a marketplace status. Current status of one marketplace. Aggregated over all traffic; contains no data of other clients. available is null when there is not enough recent data.

marketplace
string

Marketplace code.

domain
string

Amazon domain.

available
boolean· nullable

Whether this marketplace is currently served normally; null when there is not enough recent data.

status
string

operational, degraded, unavailable or unknown.

Status codes

Codes this endpoint can return, at the request or task level. See Status codes for handling advice.

CodeMessageHTTPLevelWhen
20000Ok.200Request / taskThe request, or the individual task, was processed successfully.
40100Authentication failed.401RequestThe Authorization header is missing or malformed, or the login and API key do not match.
40101API key revoked.401RequestThe API key was revoked. Use another active key or create a new one.
40102Account disabled.401RequestThe account is disabled. Contact support.
40202Rate limit exceeded.429RequestToo many requests or tasks per minute for this account, or too many access requests from one IP address. The Retry-After header says how many seconds to wait.
50000Internal error.500RequestUnexpected server error. The request can be retried; contact support if it persists.