Skip to content
Screaming Data
Documentation menu

Public & system API

OpenAPI document

Machine-readable OpenAPI 3 description of the API, with interactive docs at /docs.

GET
https://api.screamingdata.dev/openapi.json
Authentication
None
Cost
Free
Body
No request body

Overview

Returns the OpenAPI document of the API, including the security schemes (HTTP Basic and Bearer). Import it into Postman, Insomnia or a code generator. An interactive Swagger UI is served at /docs on the API host.

Cost

Free.

Request

GET /openapi.json.

This endpoint takes no parameters.

Request example

This endpoint does not need credentials.

curl --request GET \
  --url "https://api.screamingdata.dev/openapi.json"

Response

HTTP 200. The body is plain JSON (not wrapped in the response envelope).

Response example
{
  "openapi": "3.1.0",
  "info": {
    "title": "Screaming Data API",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.screamingdata.dev",
      "description": "Production"
    }
  ],
  "paths": {
    "/v1/amazon/product/task_post": {
      "post": {
        "summary": "Post product tasks",
        "operationId": "product_task_post",
        "security": [
          {
            "basicAuth": []
          },
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/v1/amazon/product/live": {
      "post": {
        "summary": "Get product data live",
        "operationId": "product_live",
        "security": [
          {
            "basicAuth": []
          },
          {
            "bearerAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      },
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  }
}

HTTP status codes

  • 200The OpenAPI document.