View raw JSON
{
"type": "object",
"required": [
"body"
],
"properties": {
"body": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"searchBy"
],
"~standard": {
"vendor": "zod",
"version": 1,
"jsonSchema": {}
},
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Maximum articles to return (1-100, default 10). This is also what sizes the admission hold — one credit per 10 articles."
},
"cursor": {
"type": "string",
"maxLength": 300,
"description": "Opaque next_cursor from the previous response to fetch the following page. Each page bills its own articles."
},
"sortBy": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"relevance",
"newest"
],
"type": "string",
"description": "Result ordering."
}
},
"description": "Result ordering. Defaults to newest.",
"additionalProperties": false
},
"filterBy": {
"type": "object",
"properties": {
"date": {
"type": "object",
"properties": {
"to": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Inclusive end of the published-at window, epoch milliseconds."
},
"from": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Inclusive start of the published-at window, epoch milliseconds."
}
},
"description": "Published-at window in epoch milliseconds.",
"additionalProperties": false
},
"articleType": {
"type": "array",
"items": {
"enum": [
"editorial",
"press_release",
"regulatory_filing",
"advisory"
],
"type": "string"
},
"maxItems": 3,
"minItems": 1,
"description": "Article types to include (up to 3) — separates independent reporting (editorial) from company-issued content."
},
"sourceDomain": {
"type": "array",
"items": {
"type": "string",
"maxLength": 253,
"minLength": 1
},
"maxItems": 3,
"minItems": 1,
"description": "Publisher domains to include (up to 3)."
},
"sourceCountry": {
"type": "array",
"items": {
"enum": [
"ae",
"ar",
"au",
"ca",
"cg",
"ch",
"cl",
"cz",
"de",
"fi",
"fr",
"gb",
"hk",
"il",
"in",
"jp",
"kr",
"mx",
"ng",
"nl",
"qa",
"sa",
"se",
"sg",
"us",
"za"
],
"type": "string"
},
"maxItems": 3,
"minItems": 1,
"description": "Publisher countries to include, as lowercase ISO 3166-1 alpha-2 codes (up to 3)."
},
"articleLanguage": {
"type": "array",
"items": {
"enum": [
"ar",
"de",
"en",
"es",
"fr",
"hi",
"it",
"ja",
"ko",
"nl",
"pt",
"ru",
"zh"
],
"type": "string"
},
"maxItems": 3,
"minItems": 1,
"description": "Article languages to include, as ISO 639-1 codes (up to 3)."
}
},
"description": "Optional result filters.",
"additionalProperties": false
},
"searchBy": {
"type": "object",
"required": [
"type",
"entity"
],
"properties": {
"type": {
"type": "string",
"const": "entity",
"description": "How to search. Only entity search is supported."
},
"entity": {
"oneOf": [
{
"type": "object",
"required": [
"type",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 2,
"description": "Company name."
},
"type": {
"type": "string",
"const": "name"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"domain"
],
"properties": {
"type": {
"type": "string",
"const": "domain"
},
"domain": {
"type": "string",
"maxLength": 253,
"minLength": 1,
"description": "Company website domain, e.g. 'apple.com'."
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"ticker"
],
"properties": {
"type": {
"type": "string",
"const": "ticker"
},
"ticker": {
"type": "string",
"pattern": "^[A-Za-z0-9.-]+$",
"maxLength": 20,
"minLength": 1,
"description": "Public-company stock ticker, e.g. 'AAPL'."
},
"exchange": {
"type": "string",
"maxLength": 10,
"minLength": 2,
"description": "Exchange code disambiguating a ticker listed on several exchanges, e.g. 'NASDAQ', 'NYSE', 'LSE', 'XETRA'."
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"isin"
],
"properties": {
"isin": {
"type": "string",
"pattern": "^[A-Za-z]{2}[A-Za-z0-9]{9}[0-9]$",
"description": "International Securities Identification Number, e.g. 'US0378331005'."
},
"type": {
"type": "string",
"const": "isin"
}
},
"additionalProperties": false
}
],
"description": "The company to search news for — identify it by exactly one of name, domain, ticker (optionally scoped to an exchange), or ISIN."
}
},
"description": "What to search for.",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}