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

CMS Open Payments Datastore Query API

Structured query over a dataset distribution.

CMS Open Payments Datastore Query API is one of 5 APIs that CMS Open Payments publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Datastore Query. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://openpaymentsdata.cms.gov/api/1.

3 operations 2 paths 3 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://openpaymentsdata.cms.gov/api/1
Resource Areas
1

Paths & Operations 3

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

Datastore Query 3

Structured query over a dataset distribution.

GET
/datastore/query/{datasetId}/{index}
Query a dataset distribution (GET)
queryDatastoreByDatasetGet 6 params → 200
POST
/datastore/query/{datasetId}/{index}
Query a dataset distribution (POST)
queryDatastoreByDatasetPost 2 params body → 200
POST
/datastore/query/{distributionId}
Query a distribution directly
queryDatastoreByDistribution 1 param body → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Query (5 properties), QueryResult (4 properties), Condition (3 properties). Each schema is shown below with its type and property counts.

Query
object
A structured datastore query.
5 properties
Condition
object
3 properties
QueryResult
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

open-payments-datastore-query-api-openapi.yml Raw ↑

Other APIs CMS Open Payments publishes across the network.

CMS Open Payments Datastore SQL API
CMS Open Payments Download API
CMS Open Payments Metastore API
CMS Open Payments Search API