Currents API · Schema

Results

Standard results envelope returned by Currents API news endpoints

NewsMediaSearchRESTReal-Time

Properties

Name Type Description
status string Response status indicator
news array Array of news articles
View JSON Schema on GitHub

JSON Schema

results.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://currentsapi.services/schema/results",
  "title": "Results",
  "description": "Standard results envelope returned by Currents API news endpoints",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": ["ok", "error"],
      "description": "Response status indicator"
    },
    "news": {
      "type": "array",
      "description": "Array of news articles",
      "items": {
        "$ref": "news.json"
      }
    }
  },
  "required": ["status"]
}