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

Operations to create, update, and delete company entities.Entities are the building blocks of Company Watchlist. Each entity representsa company (or person) you want to track. Add identifying information such asdomain, alternative names, and key persons to improve matching quality.

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

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

This API exposes 6 operations across 3 paths, and defines 15 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.

6 operations 3 paths 15 schemas 1 DELETE2 GET1 PATCH2 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 Entities 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 6

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

Entities 6

Operations to create, update, and delete company entities. Entities are the building blocks of Company Watchlist. Each entity represents a company (or person) you want to track. A…

GET
/catchAll/entities
List entities
listEntities 7 params → 200403
POST
/catchAll/entities
Create entity
createEntity body → 200400403
POST
/catchAll/entities/batch
Create entities in batch
createEntitiesBatch body → 200400403
GET
/catchAll/entities/{entity_id}
Get entity
getEntity 1 param → 200403404
PATCH
/catchAll/entities/{entity_id}
Update entity
updateEntity 1 param body → 200400403404
DELETE
/catchAll/entities/{entity_id}
Delete entity
deleteEntity 1 param → 204403404

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are EntityResponse (10 properties), EntityListResponse (4 properties), CreateEntityRequest (4 properties), CompanyAttributes (4 properties). Each schema is shown below with its type and property counts.

UpdateEntityRequest
object
Request body for updating an entity. All fields are optional — only fields included in the request are updated. Fields not included are left unchanged. Note: W…
3 properties
AdditionalAttributes
object
Additional attributes for the entity, keyed by entity type.
1 property
CreateEntityResponse
object
2 properties 2 required
CreateEntitiesBatchResponse
object
2 properties 2 required
CreateEntitiesBatchRequest
object
1 property 1 required
Error
object
1 property
CreateEntityRequest
object
Request body for creating a single entity. Only name is required. The more fields you provide, the better the matching quality.
4 properties 1 required
EntityResponse
object
10 properties 5 required
EntityValidationErrorBody
object
Error body returned by entity endpoints for field-level validation failures. Uses a different structure from the standard Error schema ({"detail": "..."}) used…
3 properties 3 required
EntityType
string
The type of entity. - company: A company or organization (default). - person: An individual person.
EntitySortBy
string
Fields available for sorting entity list results.
EntityListResponse
object
4 properties 4 required
EntityStatus
string
Processing status of an entity. - pending: Entity has been created and is queued for enrichment. - enriching: Enrichment is in progress. - ready: Enrichment co…
SortOrder
string
Sort direction for list results. - asc: ascending (oldest or smallest first) - desc: descending (newest or largest first)
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-entities-api-openapi.yml Raw ↑

Other APIs Newscatcher publishes across the network.

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