Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Newscatcher SearchByLink API

Operations to search by link or ID.

Newscatcher SearchByLink API is one of 16 APIs that Newscatcher publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include SearchByLink. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 1 path, and defines 18 schemas. It is described by OpenAPI 3.0.3, at version 1.2.0.

Requests are made against a single base URL, https://local-news.newscatcherapi.com.

2 operations 1 paths 18 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.2.0
Base URL
https://v3-api.newscatcherapi.com/api
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Newscatcher SearchByLink API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-token (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — 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](https://www.ne…

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

SearchByLink 2

Operations to search by link or ID.

GET
/api/search_by_link
Search articles by links or IDs
searchByLinkGet 7 params → 200400401403408422429500
POST
/api/search_by_link
Search articles by links or IDs
searchByLinkPost body → 200400401403408422429500

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are ArticleEntity (37 properties), NlpDataEntity (17 properties), BaseSearchResponseDto (5 properties), AllLinksDataItem (3 properties). Each schema is shown below with its type and property counts.

ArticlesDto
array
A list of articles matching the search criteria.
UserInputDto
object
The user input parameters for the request.
NlpDataEntity
object
Natural Language Processing data for the article.
17 properties
Ids
The Newscatcher article ID (corresponds to the id field in API response) or a list of article IDs to search for. To specify multiple IDs, use a comma-separated…
To
The ending point in time to search up to. Accepts date-time strings in ISO 8601 format and plain text strings. The default time zone is UTC. Formats with examp…
RobotsCompliant
boolean
If true, returns only articles that comply with the publisher's robots.txt rules. If false, returns only articles that do not comply with robots.txt rules. If…
NamedEntityList
array
A list of named entities identified in the article.
SentimentScores
object
Sentiment scores for the article's title and content.
2 properties
PageSize
integer
The number of articles to return per page.
Error
object
3 properties 3 required
ArticleEntity
object
The data model representing a single article in the search results.
37 properties 8 required
SearchResponseDto
The response model for the search requests applies to the Search, Latest Headlines, Search by link, and Authors endpoints. Response field behavior: - Required…
AllLinksDataItem
object
Detailed information about a link found in an article.
3 properties 3 required
From
The starting point in time to search from. Accepts date-time strings in ISO 8601 format and plain text strings. The default time zone is UTC. Formats with exam…
BaseSearchResponseDto
object
The base response model containing common fields for search operations.
5 properties 5 required
Page
integer
The page number to scroll through the results. Use for pagination, as a single API response can return up to 1,000 articles. For details, see [Retrieve large d…
Links
The article link or list of article links to search for. To specify multiple links, use a comma-separated string or an array of strings. Caution: You can use e…
AdditionalDomainInfoEntity
object
Additional information about the domain of the article.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

newscatcher-searchbylink-api-openapi.yml Raw ↑

Other APIs Newscatcher publishes across the network.

Newscatcher AggregationCount API
Newscatcher Authors API
Newscatcher BreakingNews API
Newscatcher Datasets API
Newscatcher Entities API
Newscatcher Jobs API
Newscatcher LatestHeadlines API
Newscatcher Meta API
Newscatcher Monitors API
Newscatcher Projects API
Newscatcher Search API
Newscatcher SearchBy API