POST
/
api
/
search_by_link
Search articles by links or IDs
curl --request POST \
  --url https://v3-api.newscatcherapi.com/api/search_by_link \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: <api-key>' \
  --data '{
  "ids": [
    "8ea8a784568ffaa05cb6d1ab2d2e84dd",
    "0146a551ef05ab1c494a55e806e3ce64"
  ],
  "links": [
    "https://www.nytimes.com/2024/08/30/technology/ai-chatbot-chatgpt-manipulation.html",
    "https://www.bbc.com/news/articles/c39k379grzlo"
  ]
}'
{
  "status": "<string>",
  "total_hits": 123,
  "page": 123,
  "total_pages": 123,
  "page_size": 123,
  "articles": [],
  "user_input": {}
}

Authorizations

​
x-api-token
string
header
required

API Key to authenticate requests.

To access the API, include your API key in the x-api-token header. To obtain your API key, complete the form or contact us directly.

Body

application/json

Request body for searching articles based on specified links or IDs.

The body is of type object.

Response

200
application/json

A successful response containing articles that match the provided links or IDs.

The response model for the search requests applies to the Search, Latest Headlines, Search by link, and Authors endpoints. Response field behavior:

  • Required fields are guaranteed to be present and non-null.
  • Optional fields may be null or undefined if the data point is not presented or couldn't be extracted during processing.
  • To access article properties in the articles response array, use array index notation. For example, articles[n].title, where n is the zero-based index of the article object (0, 1, 2, etc.).
  • The nlp property within the article object articles[n].nlp is only available with NLP-enabled subscription plans.

The base response model containing common fields for search operations.