POST
/
api
/
search_by
curl --request POST \
  --url https://local-news.newscatcherapi.com/api/search_by \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: <api-key>' \
  --data '{
  "links": "https://nytimes.com/article1",
  "ids": [
    "5f8d0d55b6e45e00179c6e7e",
    "5f8d0d55b6e45e00179c6e7f"
  ],
  "rss_guids": [
    "https://example.com/article1",
    "https://example.com/article2"
  ],
  "from_": "2024/09/24",
  "to_": "2024/09/25",
  "page": 2,
  "page_size": 100
}'
{
  "status": "ok",
  "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

Response

200
application/json
A successful response containing articles that match the specified search criteria.

The response model for the Search, Latest headlines, and Search by requests, including search results and metadata.

Response field behavior:

  • Required fields are guaranteed to be present and non-null.
  • Optional fields may be null/undefined if the data 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.).