HHS (US Department of Health and Human Services) Extract v1 API
The Extract v1 API from HHS (US Department of Health and Human Services) — 1 operation(s) for extract v1.
HHS (US Department of Health and Human Services) Extract v1 API is one of 21 APIs that HHS (US Department of Health and Human Services) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 6 JSON Schema definitions.
Tagged areas include Extract v1. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, rate-limit docs, and 6 JSON Schemas.
This API exposes 1 operation across 1 path, and defines 11 schemas. It is described by OpenAPI 3.1.0, at version v0.
Requests are made against the base URL https://api.fda.gov.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
HHS (US Department of Health and Human Services) Extract v1 API declares
3 security schemes
for authenticating requests.
An API key is passed in the header as X-SGG-Token (ApiJwtAuth).
An API key is passed in the header as X-SGG-Internal-Token (InternalApiJwtAuth).
An API key is passed in the header as X-API-Key (ApiUserKeyAuth).
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.
Schemas 11
The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are ExtractMetadataResponseSchema (6 properties), ErrorResponseSchema (5 properties), ExtractMetadataRequestSchema (5 properties), PaginationInfoSchema (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from HHS (US Department of Health and Human Services) 12
Other APIs HHS (US Department of Health and Human Services) publishes across the network.