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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Newscatcher

Newscatcher Jobs API

Operations to create, monitor, and retrieve job results.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 8 operations across 8 paths, and defines 37 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.

8 operations 8 paths 37 schemas 1 DELETE3 GET4 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
Contact
Maksym Sugonyaka
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Newscatcher Jobs 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 8

Across 8 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Jobs 8

Operations to create, monitor, and retrieve job results.

GET
/catchAll/jobs/user
List user jobs
getUserJobs 5 params → 200403
POST
/catchAll/validate
Validate query
validateQuery body → 200403422
POST
/catchAll/initialize
Initialize job
initialize body → 200403422
POST
/catchAll/submit
Create job
createJob body → 200400403422
GET
/catchAll/status/{job_id}
Get job status
getJobStatus 1 param → 200403404
GET
/catchAll/pull/{job_id}
Get job results
getJobResults 3 params → 200403404
POST
/catchAll/continue
Continue job
continueJob body → 200400403422
DELETE
/catchAll/jobs/{job_id}
Delete job
deleteJob 1 param → 200401404

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are PullJobResponseDto (19 properties), SubmitRequestDto (14 properties), ConnectedEntity (7 properties), UserJob (7 properties). Each schema is shown below with its type and property counts.

Citation
object
3 properties 3 required
StartDate
string
Start date for web search (ISO 8601 format with UTC timezone). Defines the start of the search window by web page discovery date, not event date. Web pages dis…
Suggestion
object
Actionable recommendation for improving a query.
3 properties 2 required
StatusResponseDto
object
3 properties 1 required
ListUserJobsResponseDto
object
5 properties 5 required
EndDate
string
End date for web search (ISO 8601 format with UTC timezone). Defines the end of the search window by web page discovery date, not event date. Web pages discove…
BaseRecord
object
3 properties 3 required
EnrichmentSchema
object
Schema for a single enrichment field that extracts structured data. Enrichments are applied during the enriching stage to extract information from validated cl…
3 properties 3 required
UserJob
object
7 properties 4 required
ValidationErrorDetail
object
3 properties
Context
string
Additional context to focus on specific aspects of your query.
Query
string
Plain text question describing what to find. The system analyzes your input to generate search queries, validators, and extractors. More specific queries produ…
ContinueResponseDto
object
4 properties 3 required
ValidatorSchema
object
Schema for a single validator that filters clusters of web pages. Validators are applied during the enriching stage to determine which clusters are relevant.
3 properties 2 required
JobStep
object
3 properties 3 required
ValidateQueryRequestDto
object
1 property 1 required
ValidationErrorResponse
object
1 property
PullJobResponseDto
object
19 properties 1 required
SharingInfo
object
Present on resources shared with the authenticated user by another organization member. Omitted entirely on resources the user owns.
3 properties 3 required
InitializeRequestDto
object
Request to get validator, enrichment, and date range suggestions for a query.
4 properties 1 required
Record
SubmitRequestDto
object
14 properties 1 required
Error
object
1 property
Limit
integer
Maximum number of records to return. If not specified, defaults to your plan limit. Use [POST /catchAll/continue](https://www.newscatcherapi.com/docs/web-searc…
EntityAssociationType
string
How an entity relates to an event. - eventassociated: The entity is a direct actor in the event (primary subject). - mention: The entity is merely referenced i…
ConnectedEntity
object
A company entity matched to a record in a Company Watchlist job, with a relevance score and explanation. Only entities with edscore ≥ 1 appear in results. Enti…
7 properties 5 required
DeleteJobResponseDto
object
3 properties 3 required
ValidateQueryResponseDto
object
Query quality assessment returned by the validate endpoint.
6 properties 3 required
SubmitResponseDto
object
1 property 1 required
QueryStatus
string
Quality level assigned to a query by the validation endpoint. - good: Query is well-formed and likely to produce relevant results. - needswork: Query has issue…
InitializeResponseDto
object
7 properties 3 required
PublicJobStatus
string
Current job processing status. Jobs progress through these stages: - submitted: Job queued, waiting to start processing. - analyzing: Extracting keywords, gene…
EnrichmentType
string
Canonical enrichment types supported by the system. - text: Free-form text strings (names, descriptions, summaries) - number: Numeric values (amounts, counts,…
OwnershipFilter
string
Controls which resources are returned based on ownership. - all: Returns resources owned by the user and resources shared with them (default, backward compatib…
ContinueRequestDto
object
2 properties 1 required
IssueType
string
Category of a query issue identified during validation. - missingeventtype: Query does not specify a type of event to find. - toovague: Query lacks sufficient…
CompanyAttributes
object
Identifying attributes for a company entity. All fields are optional but improve matching quality.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

newscatcher-jobs-api-openapi.yml Raw ↑

Other APIs Newscatcher publishes across the network.

Newscatcher AggregationCount API
AE Profile APIs.io
Newscatcher Authors API
AE Profile APIs.io
Newscatcher BreakingNews API
AE Profile APIs.io
Newscatcher Datasets API
AE Profile APIs.io
Newscatcher Entities API
AE Profile APIs.io
Newscatcher LatestHeadlines API
AE Profile APIs.io
Newscatcher Meta API
AE Profile APIs.io
Newscatcher Monitors API
AE Profile APIs.io
Newscatcher Projects API
AE Profile APIs.io
Newscatcher Search API
AE Profile APIs.io
Newscatcher SearchBy API
AE Profile APIs.io
Newscatcher SearchByLink API
AE Profile APIs.io
#Jobs
← Back to N APIs
API Details
ID
newscatcher:newscatcher-jobs-api
Base URL
https://v3-api.newscatcherapi.com/api
Docs
https://www.newscatcherapi.com/news-api
Provider
Newscatcher
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network