Raw schema
{
"type": "object",
"properties": {
"text": {
"description": "Full-text search query. Matches against title, body, and key metadata fields. Use plain natural language or keywords.",
"type": "string"
},
"country": {
"description": "ISO 3166-1 alpha-3 country code (e.g., SYR, AFG, UKR). Filters to content tagged with this country.",
"type": "string"
},
"disaster_id": {
"description": "ReliefWeb numeric disaster ID. Filters to reports linked to a specific disaster. Get the ID from reliefweb_search_disasters.",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"format": {
"description": "Content format filter. One of: News and Press Release, Situation Report, Map, Infographic, Analysis, Other, Assessment, Manual and Guideline, Appeal, UN Document, Evaluation and Lessons Learned. Case, spacing, and punctuation are ignored; any other value is rejected with the valid list.",
"type": "string"
},
"theme": {
"description": "Sector or cross-cutting theme (e.g., Health, Food and Nutrition, Shelter and Non-Food Items, Protection). Open-ended โ matches theme.name exactly as ReliefWeb spells it.",
"type": "string"
},
"language": {
"description": "ISO 639-1 language code (e.g., en, fr, es, ar). Filters on language.code.",
"type": "string"
},
"source": {
"description": "Organization short name (e.g., UNHCR, OCHA, WFP). Filters on source.shortname.",
"type": "string"
},
"date_from": {
"description": "Earliest publication date. Filters on date.original (source publication date). A bare calendar date such as 2024-01-15 is accepted and resolves to start of that day in UTC; a datetime carrying any offset is resolved to UTC.",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d+)?)?(?:Z|[+-]\\d{2}:?\\d{2})?)?$",
"description": "Calendar date (2024-01-15) or full ISO 8601 datetime (2024-01-15T00:00:00+00:00)."
}
]
},
"date_to": {
"description": "Latest publication date. Pair with date_from for a date range. A bare calendar date resolves to end of that day in UTC, so the range covers it in full; a datetime carrying any offset is resolved to UTC.",
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d+)?)?(?:Z|[+-]\\d{2}:?\\d{2})?)?$",
"description": "Calendar date (2024-01-31) or full ISO 8601 datetime (2024-01-31T23:59:59+00:00)."
}
]
},
"sort": {
"description": "Sort order. Use date.original:desc for newest first (default), date.original:asc for oldest first, score:desc for relevance.",
"type": "string"
},
"include_archived": {
"description": "No effect on reports. Reports have no archived class โ every report is already in scope, whatever this is set to. Kept so existing calls that pass it keep working; it is meaningful on reliefweb_search_jobs, reliefweb_search_training, and reliefweb_search_disasters.",
"type": "boolean"
},
"filter": {
"description": "Raw ReliefWeb filter object for compound conditions not covered by named params. Example: {\"operator\": \"AND\", \"conditions\": [{\"field\": \"format.name\", \"value\": \"Map\"}, {\"field\": \"language.code\", \"value\": \"fr\"}]}.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"limit": {
"default": 10,
"description": "Number of results to return (1โ1000, default 10). Use a smaller value for targeted lookups; larger for bulk research. Each call counts against the 1,000-calls/day quota.",
"type": "integer",
"minimum": 1,
"maximum": 1000
},
"offset": {
"default": 0,
"description": "Zero-based offset for pagination. Use with limit and the totalCount enrichment field to page through large result sets.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}