Skip to main content
GET
/
api
/
search
Search articles
curl --request GET \
  --url https://v3-api.newscatcherapi.com/api/search \
  --header 'x-api-token: <api-key>'
{
  "status": "<string>",
  "total_hits": 123,
  "page": 123,
  "total_pages": 123,
  "page_size": 123,
  "articles": [],
  "user_input": {}
}

Authorizations

​
x-api-token
string
header
required

Query Parameters

​
q
string
required
Example:
​
search_in
string
default:title_content
Example:
​
include_translation_fields
boolean
default:false
Example:
​
predefined_sources
string
​
source_name
string
​
sources
string
​
not_sources
string
​
lang
string
​
not_lang
string
​
countries
string
​
not_countries
string
​
not_author_name
string
​
from_
default:7 days ago
Example:
​
to_
Example:
​
published_date_precision
enum<string>
Available options:
full,
timezone unknown,
date
​
by_parse_date
boolean
default:false
​
sort_by
enum<string>
default:relevancy
Available options:
relevancy,
date,
rank
​
ranked_only
boolean
default:true
​
from_rank
integer
default:1
Required range: 1 <= x <= 999999
​
to_rank
integer
default:999999
Required range: 1 <= x <= 999999
​
is_headline
boolean
​
is_opinion
boolean
​
is_paid_content
boolean
​
parent_url
string
​
all_links
string
​
all_domain_links
string
​
additional_domain_info
boolean
​
is_news_domain
boolean
​
news_domain_type
enum<string>
Available options:
Original Content,
Aggregator,
Press Releases,
Republisher,
Other
​
news_type
string
​
word_count_min
integer
Required range: x >= 0
​
word_count_max
integer
Required range: x >= 0
​
page
integer
default:1
Required range: x >= 1
​
page_size
integer
default:100
Required range: 1 <= x <= 1000
​
clustering_enabled
boolean
default:false
​
clustering_variable
enum<string>
default:content
Available options:
content,
title,
summary
​
clustering_threshold
number
default:0.6
Required range: 0 < x <= 1
​
include_nlp_data
boolean
default:false
Example:
​
has_nlp
boolean
default:false
Example:
​
theme
string
​
not_theme
string
​
ORG_entity_name
string
​
PER_entity_name
string
​
LOC_entity_name
string
​
MISC_entity_name
string
​
title_sentiment_min
number
Required range: -1 <= x <= 1
​
title_sentiment_max
number
Required range: -1 <= x <= 1
​
content_sentiment_min
number
Required range: -1 <= x <= 1
​
content_sentiment_max
number
Required range: -1 <= x <= 1
​
iptc_tags
string
​
not_iptc_tags
string
​
iab_tags
string
​
not_iab_tags
string
​
custom_tags
string
​
exclude_duplicates
boolean
​
robots_compliant
boolean

Response

  • Search Response
  • Clustered Articles Response
​
status
string
required
​
total_hits
integer
required
​
page
integer
required
​
total_pages
integer
required
​
page_size
integer
required
​
articles
Article Object · object[]
​
user_input
object