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 SearchBy API

Operations to search local news by link, ID or RSS GUID.

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

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

This API exposes 1 operation across 1 path, and defines 20 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.

1 operations 1 paths 20 schemas 1 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 SearchBy 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 1

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

SearchBy 1

Operations to search local news by link, ID or RSS GUID.

POST
/api/search_by
Search articles by identifiers
SearchBy_post body → 200400401403408422429500

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are BaseArticleEntity (26 properties), GeoNamesResponseEntity (14 properties), NlpDataEntity (12 properties), SearchByRequestDto (7 properties). Each schema is shown below with its type and property counts.

ArticleAdvancedResultEntity
GeoNamesLocationAdminEntity
object
3 properties
BaseArticleEntity
object
The data model representing the commont properties of the article object in the search results. Required fields are always non-null. Optional fields may be nul…
26 properties 9 required
ArticleSearchAdvancedResponseDto
The response model for the Search advanced, Latest headlines advanced, and Search by requests. Response field behavior: - Required fields are guaranteed to be…
NlpDataEntity
object
Natural Language Processing data for the article.
12 properties
Ids
The Newscatcher article ID (see the id field in API response) or a list of article IDs to search for. To specify multiple IDs, use a comma-separated string or…
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…
NamedEntityList
array
A list of named entities identified in the article.
SentimentScores
object
Sentiment scores for the article's title and content.
2 properties
RssGuids
The RSS GUID (Globally Unique Identifier) or list of GUIDs to search for. To specify multiple GUIDs, use a comma-separated string or an array of strings. GUIDs…
PageSize
integer
The number of articles to return per page. Range: 1 to 1000.
SearchByRequestDto
object
7 properties
Coordinates
object
Geographic coordinates for a location.
2 properties
Error
object
3 properties 3 required
GeoNamesResponseEntity
object
Represents a geographic location identified in an article using GeoNames structured data, including detection confidence and localization scores.
14 properties 2 required
DetectionMethods
array
The location detection methods to filter results by: - dedicatedsource: Identifies locations based on sources exclusively covering a specific location. - local…
SearchResponseDto
object
5 properties 5 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…
Page
integer
The page number to scroll through the results. This parameter is used to paginate: scroll through results because one API response cannot return more than 1000…
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. Note: You can use the…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

newscatcher-searchby-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 SearchByLink API