GET /Search/query/

Class: Search, Method: query

Performs a search query in order to retrieve search results containing news and reports
documents based on certain search criteria.
XSD Schema
JSON Schema

Path Parameters

Name Description Type Required Default
response_format Response data format. Default is json.
Accepted Values: [ json,xml]
String json

Query Parameters

Name Description Type Required Default
countries List of country codes Array
languages List of language codes Array en
formats List of file format indexes Array 1,4,2,3
companies List of company IDs Array
industries List of NAICS industry codes Array
topics List of topic codes Array
sourceTypes List of source type codes Array
publications List of publication codes Array
publicationTypes List of publication type codes. Examples: TN, TA, TNPR Array
startDate Start date ISO format. If not passed, a default value exactly one year interval back from now will be set String
endDate End date ISO format String
updatedAfterDate Filters only the documents, which are updated in the database after the defined date. The date is in ISO format String
term Search term String
scope Search scope. Possible values are 'everywhere' and 'title' String everywhere
startDocumentId Start Document ID Integer
offset Offset of the search result Integer 0
limit Maximum number of records to be returned Integer 25
order Sort order. Valid values are 'relevance', 'newest', 'oldest', 'id_asc' and 'id_desc' String newest
skipDuplicates Indicates whenever duplicates found should be skipped Integer True
includeBody Indicates whenever the content body shall be included Integer False


Status Code Description Type
200 Returns response result. Result < Search >
400 Returns API error. ApiError[]
API Query Builder
Query Result