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

Operations to create and manage datasets of entities.A dataset is a named collection of entities — think of it as a watchlist orportfolio. Connect a dataset to a job via `connected_dataset_ids` to activateCompany Watchlist. Datasets can be reused across multiple jobs and monitors.

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

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

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

11 operations 7 paths 26 schemas 2 DELETE3 GET1 PATCH5 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 Datasets 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 11

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

Datasets 11

Operations to create and manage datasets of entities. A dataset is a named collection of entities — think of it as a watchlist or portfolio. Connect a dataset to a job via connect…

GET
/catchAll/datasets
List datasets
listDatasets 8 params → 200403
POST
/catchAll/datasets
Create dataset
createDataset body → 200400403422
POST
/catchAll/datasets/upload
Create dataset from CSV
createDatasetFromCsv body → 200403422
GET
/catchAll/datasets/{dataset_id}
Get dataset
getDataset 1 param → 200403404
PATCH
/catchAll/datasets/{dataset_id}
Update dataset
updateDataset 1 param body → 200403404422
DELETE
/catchAll/datasets/{dataset_id}
Delete dataset
deleteDataset 1 param → 204403404
POST
/catchAll/datasets/{dataset_id}/entities
Add entities to dataset
addEntitiesToDataset 1 param body → 200403404422
DELETE
/catchAll/datasets/{dataset_id}/entities
Remove entities from dataset
removeEntitiesFromDataset 1 param body → 200403404422
POST
/catchAll/datasets/{dataset_id}/entities/list
List entities in dataset
listEntitiesInDataset 1 param body → 200403404422
GET
/catchAll/datasets/{dataset_id}/status
Get dataset status history
getDatasetStatusHistory 1 param → 200403404
POST
/catchAll/datasets/{dataset_id}/upload
Add companies to dataset via CSV
uploadCSVToDataset 1 param body → 200403404422

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are DatasetResponse (9 properties), ListDatasetEntitiesRequest (7 properties), EntitySummary (6 properties), DatasetEntityListResponse (4 properties). Each schema is shown below with its type and property counts.

ManageEntitiesResponse
object
2 properties 2 required
DatasetStatus
string
Processing status of a dataset. - pending: Dataset created, entities queued for enrichment. - enriching: Entities are being enriched. - ready: All entities enr…
DatasetListResponse
object
4 properties 4 required
UpdateDatasetRequest
object
Updates dataset name or description. At least one field should be provided.
2 properties
DatasetSortBy
string
Fields available for sorting dataset list results.
ValidationErrorDetail
object
3 properties
CreateDatasetCsvResponse
object
4 properties 4 required
DatasetResponse
object
9 properties 3 required
DatasetEntityIdsRequest
object
1 property 1 required
ValidationErrorResponse
object
1 property
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…
DatasetEntityListResponse
object
4 properties 4 required
Error
object
1 property
DatasetStatusHistoryResponse
object
2 properties 2 required
DatasetStatusEntry
object
A single status change event in a dataset's history.
3 properties 1 required
EntitySummary
object
Abbreviated entity object returned when listing entities within a dataset. Uses a flat attributes key rather than the nested additionalattributes.companyattrib…
6 properties 4 required
ValidationReport
object
Summary of CSV processing results.
4 properties 4 required
EntitySortBy
string
Fields available for sorting entity list results.
EntityType
string
The type of entity. - company: A company or organization (default). - person: An individual person.
CreateDatasetRequest
object
3 properties 1 required
SkippedRow
object
Details about a CSV row that was skipped during processing.
2 properties 2 required
ListDatasetEntitiesRequest
object
7 properties
UploadCsvToDatasetResponse
object
3 properties 3 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-datasets-api-openapi.yml Raw ↑

Other APIs Newscatcher publishes across the network.

Newscatcher AggregationCount API
Newscatcher Authors API
Newscatcher BreakingNews 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
Newscatcher SearchByLink API