Raw schema
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Search by article title. Up to 3 keywords comma-separated (OR). Phrase in quotes for exact match."
},
"ignore": {
"type": "object",
"description": "Exclusion filters — exclude articles matching these. Mirror the positive filters.",
"properties": {
"title": {
"type": "string",
"description": "Exclude titles with these keyword(s), comma-separated."
},
"language": {
"type": "object",
"properties": {
"code": {
"type": "string"
}
}
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
},
"topic": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
},
"industry": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
},
"entity": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
},
"person": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"location": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"organization": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"disaster": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"disease": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"event": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Exclude these event codes (max 5)."
},
"name": {
"type": "string",
"description": "Exclude these named events (up to 3)."
}
}
},
"brand": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"author": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"source": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"domain": {
"type": "string"
},
"country": {
"type": "object",
"properties": {
"code": {
"type": "string"
}
}
},
"bias": {
"type": "string"
}
}
}
}
},
"language": {
"type": "object",
"description": "Language filter.",
"properties": {
"code": {
"type": "string",
"description": "ISO codes, comma-separated up to 3 (e.g. \"en,ru,fr\")."
}
}
},
"category": {
"type": "object",
"description": "IPTC category filter.",
"properties": {
"id": {
"type": "string",
"description": "Category id, e.g. \"medtop:04000000\". Comma-separated up to 3."
}
}
},
"topic": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Topic id(s), comma-separated up to 3."
}
}
},
"industry": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Industry id(s), comma-separated up to 3."
}
}
},
"entity": {
"type": "object",
"description": "Named-entity filter.",
"properties": {
"id": {
"type": "string",
"description": "Numeric entity id(s), comma-separated up to 3."
}
}
},
"person": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Person name(s), comma-separated up to 3."
}
}
},
"organization": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Organization name(s), comma-separated up to 3."
}
}
},
"location": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Location name(s), comma-separated up to 3."
}
}
},
"disaster": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Disaster name(s), comma-separated up to 3."
}
}
},
"disease": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Disease name(s), comma-separated up to 3."
}
}
},
"event": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Event codes, comma-separated (max 5) — see /v1/news/event-types, e.g. layoffs, ipo, recall, wildfire."
},
"category": {
"type": "string",
"enum": [
"business",
"society",
"environment"
],
"description": "Event family."
},
"name": {
"type": "string",
"description": "Named event entity, comma-separated up to 3. The directory is nearly empty — prefer type/category; an unknown name returns 400 ER0228."
}
}
},
"brand": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Brand name(s), comma-separated up to 3."
}
}
},
"source": {
"type": "object",
"description": "Source filter.",
"properties": {
"id": {
"type": "string",
"description": "Source id(s), comma-separated up to 3."
},
"domain": {
"type": "string",
"description": "Domain(s), e.g. \"cnn.com,bbc.com\"."
},
"country": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Country code(s), e.g. \"us,uk,de\"."
}
}
},
"bias": {
"type": "string",
"enum": [
"left",
"center",
"right"
],
"description": "Media bias (comma-separated for multiple)."
},
"rank": {
"type": "object",
"properties": {
"opr": {
"type": "object",
"description": "OpenPageRank range (0-7).",
"properties": {
"min": {
"type": "number"
},
"max": {
"type": "number"
}
}
}
}
}
}
},
"author": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Author id(s), comma-separated up to 3."
},
"name": {
"type": "string",
"description": "Author name(s), comma-separated up to 3."
}
}
},
"sentiment": {
"type": "object",
"description": "Sentiment filter. Scores range -1.0..1.0.",
"properties": {
"overall": {
"type": "object",
"properties": {
"polarity": {
"type": "string",
"enum": [
"positive",
"negative",
"neutral"
],
"description": "Overall sentiment polarity."
},
"score": {
"type": "object",
"properties": {
"min": {
"type": "number"
},
"max": {
"type": "number"
}
}
}
}
},
"title": {
"type": "object",
"properties": {
"score": {
"type": "object",
"properties": {
"min": {
"type": "number"
},
"max": {
"type": "number"
}
}
}
}
},
"body": {
"type": "object",
"properties": {
"score": {
"type": "object",
"properties": {
"min": {
"type": "number"
},
"max": {
"type": "number"
}
}
}
}
},
"mixed": {
"type": "integer",
"enum": [
0,
1
],
"description": "Title/body sentiment differ."
},
"consistent": {
"type": "integer",
"enum": [
0,
1
],
"description": "Title/body sentiment agree."
}
}
},
"media": {
"type": "object",
"description": "Media-content filter.",
"properties": {
"images": {
"type": "object",
"properties": {
"count": {
"type": "object",
"properties": {
"min": {
"type": "integer"
},
"max": {
"type": "integer"
}
}
},
"width": {
"type": "object",
"properties": {
"min": {
"type": "integer"
},
"max": {
"type": "integer"
}
}
},
"height": {
"type": "object",
"properties": {
"min": {
"type": "integer"
},
"max": {
"type": "integer"
}
}
}
}
},
"videos": {
"type": "object",
"properties": {
"count": {
"type": "object",
"properties": {
"min": {
"type": "integer"
},
"max": {
"type": "integer"
}
}
}
}
}
}
},
"published_at": {
"type": "object",
"description": "Publication date range (ISO 8601).",
"properties": {
"start": {
"type": "string",
"description": "YYYY-MM-DD or RFC3339."
},
"end": {
"type": "string",
"description": "YYYY-MM-DD or RFC3339."
}
}
},
"sort": {
"type": "object",
"properties": {
"by": {
"type": "string",
"enum": [
"published_at",
"created_at",
"id",
"source.rank.opr",
"read_time",
"sentiment.overall.score",
"sentiment.title.score",
"sentiment.body.score",
"media.images.count",
"media.videos.count",
"media.images.width.min",
"media.images.width.max",
"media.images.height.min",
"media.images.height.max",
"media_richness",
"shares.facebook.min",
"shares.facebook.max",
"shares.twitter.min",
"shares.twitter.max",
"shares.reddit.min",
"shares.reddit.max",
"relevance",
"engagement",
"quality",
"controversy",
"trust"
],
"description": "Field to sort by."
},
"order": {
"type": "string",
"enum": [
"asc",
"desc"
],
"description": "Sort direction."
}
}
},
"read_time": {
"type": "object",
"description": "Reading time in minutes.",
"properties": {
"min": {
"type": "integer"
},
"max": {
"type": "integer"
}
}
},
"facet": {
"type": [
"boolean",
"object"
],
"description": "Enable faceting (true) or object form for analytics.",
"properties": {
"field": {
"type": "string",
"description": "Facet field(s), comma-separated."
},
"limit": {
"type": "integer"
},
"mincount": {
"type": "integer"
},
"range": {
"type": "object",
"description": "Range faceting → facet.range.* params.",
"properties": {
"field": {
"type": "string",
"description": "Numeric/date field to bucket."
},
"start": {
"type": "string"
},
"end": {
"type": "string"
},
"gap": {
"type": "string",
"description": "e.g. \"1MONTH\" for dates or \"0.25\" for numbers."
}
}
}
}
},
"hl": {
"type": [
"boolean",
"object"
],
"description": "Enable highlighting (true) or object form.",
"properties": {
"fl": {
"type": "string",
"description": "Fields to highlight, comma-separated."
},
"fragsize": {
"type": "integer"
},
"snippets": {
"type": "integer"
},
"tag": {
"type": "object",
"properties": {
"pre": {
"type": "string"
},
"post": {
"type": "string"
}
}
}
}
},
"has_image": {
"type": "integer",
"enum": [
0,
1
],
"description": "Articles with at least one image."
},
"has_video": {
"type": "integer",
"enum": [
0,
1
],
"description": "Articles with at least one video."
},
"has_hq_images": {
"type": "integer",
"enum": [
0,
1
],
"description": "High-quality images (width >= 1200px)."
},
"is_media_rich": {
"type": "integer",
"enum": [
0,
1
],
"description": "Both images and videos."
},
"has_author": {
"type": "integer",
"enum": [
0,
1
],
"description": "Has an attributed author."
},
"is_breaking": {
"type": "integer",
"enum": [
0,
1
],
"description": "Breaking news only."
},
"is_duplicate": {
"type": "integer",
"enum": [
0,
1
],
"description": "0 to exclude duplicates."
},
"is_paywall": {
"type": "integer",
"enum": [
0,
1
],
"description": "0 to exclude paywalled content."
},
"is_long_read": {
"type": "integer",
"enum": [
0,
1
],
"description": "Read time >= 5 minutes."
},
"is_short_read": {
"type": "integer",
"enum": [
0,
1
],
"description": "Read time < 3 minutes."
},
"is_premium_source": {
"type": "integer",
"enum": [
0,
1
],
"description": "Premium sources (OPR >= 6)."
},
"is_verified_source": {
"type": "integer",
"enum": [
0,
1
],
"description": "Verified sources (OPR >= 5)."
},
"page": {
"type": "integer",
"minimum": 1,
"description": "Page number (default 1)."
},
"per_page": {
"type": "integer",
"minimum": 1,
"maximum": 25,
"description": "Results per page (default 10). One response carries at most 25 articles."
},
"fl": {
"type": "string",
"description": "Comma-separated fields to return (dot-notation supported), e.g. \"id,title,source.name,sentiment.overall.score\"."
}
},
"required": [],
"additionalProperties": true
}