NEnewscatcherapi
SearchLink

Get articles by URL or ID

Fetch specific articles directly by their NewsCatcher article id(s) or by their exact article link(s), instead of running a full-text search. Provide either ids or links (the two are mutually exclusive and cannot be combined in the same request).

post/api/search_by_link

Request

  • Base URL
    https://v3-api.newscatcherapi.com (the document declares no server; this is the origin it was published from)
  • Auth
    none declared. Required headers: x-api-token

Headers

x-api-tokenstring required

Your NewsCatcher API key, used to authenticate this request.

Request body

idsunknown
linksunknown
pageinteger

Page number of results to return, starting at 1.

page_sizeinteger

Number of articles per page. Integer between 1 and 1000.

Response

Successful Response

statusstring

Always 'ok' for a successful search.

total_hitsinteger required

Total number of articles matching the query, across all pages.

pageinteger required

Current page number returned.

total_pagesinteger required

Total number of pages available for this query, given page_size.

page_sizeinteger required

Number of articles returned per page.

articlesobject[] required

Articles matching the query for this page.

user_inputobject required

Echo of the request parameters that produced this response.

Changes

No recorded changes to this operation across all 1 revision of this API.