The Bureau of Economic Analysis Metadata API
Methods for discovering available datasets, parameters, and valid values.
The Bureau of Economic Analysis Metadata API is one of 5 APIs that The Bureau of Economic Analysis publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Metadata. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.
This API exposes 3 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.
Requests are made against a single base URL, https://apps.bea.gov/api/data.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
The Bureau of Economic Analysis Metadata API declares
1 security scheme
for authenticating requests.
An API key is passed in the query as UserID (ApiKeyAuth).
By default, every request must be authenticated.
ApiKeyAuth— BEA API key obtained by registering at https://apps.bea.gov/api/signup/
Paths & Operations 3
Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.
Methods for discovering available datasets, parameters, and valid values.
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are ParameterValuesResponse (1 property), DatasetListResponse (1 property), ErrorResponse (1 property), ParameterListResponse (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from The Bureau of Economic Analysis 4
Other APIs The Bureau of Economic Analysis publishes across the network.