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

HHS (US Department of Health and Human Services) Opportunity v1 API

The Opportunity v1 API from HHS (US Department of Health and Human Services) — 4 operation(s) for opportunity v1.

HHS (US Department of Health and Human Services) Opportunity 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 Opportunity v1. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, rate-limit docs, and 6 JSON Schemas.

This API exposes 4 operations across 4 paths, and defines 37 schemas. It is described by OpenAPI 3.1.0, at version v0.

Requests are made against the base URL https://api.fda.gov.

4 operations 4 paths 37 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v0
Base URL
https://api.fda.gov
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

HHS (US Department of Health and Human Services) Opportunity 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 4

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

Opportunity v1 4
POST
/v1/opportunities/search
Search opportunities (JSON or CSV)
body → 200422401
POST
/v1/opportunities/search/csv
Opportunity Search Csv
body → 422401200
GET
/v1/opportunities/{opportunity_id}
Opportunity Get
1 param → 200401404
GET
/v1/opportunities/{legacy_opportunity_id}
Opportunity Get Legacy
1 param → 200401404

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are OpportunitySummaryV1Schema (30 properties), OpportunityWithAttachmentsV1Schema (18 properties), FormAlphaSchema (17 properties), OpportunityV1Schema (16 properties). Each schema is shown below with its type and property counts.

IsCostSharingFilterV1Schema
object
1 property
FormAlphaSchema
object
17 properties
CompetitionFormAlphaSchema
object
2 properties
FormInstructionSchema
object
5 properties
ValidationIssueSchema
object
4 properties
OpportunityWithAttachmentsV1Schema
object
18 properties
OpportunityAttachmentV1Schema
object
8 properties
OpportunitySearchRequestV1Schema
object
6 properties 1 required
PaginationInfoSchema
object
5 properties
OpportunitySearchResponseV1Schema
object
5 properties
ExperimentalV1Schema
object
1 property
OpportunityPaginationV1Schema
object
3 properties 2 required
OpportunityGetResponseV1Schema
object
3 properties
OpportunityV1Schema
object
16 properties
SortOrderOpportunityPaginationV1Schema
object
2 properties 2 required
ApplicantTypeFilterV1Schema
object
1 property
OpportunitySummaryV1Schema
object
30 properties
ExpectedNumberAwardsFilterV1Schema
object
2 properties
CloseDateFilterV1Schema
object
4 properties
EstimatedTotalProgramFundingFilterV1Schema
object
2 properties
PostDateFilterV1Schema
object
4 properties
OpportunityStatusFilterV1Schema
object
1 property
AwardFloorFilterV1Schema
object
2 properties
OpportunityFacetV1Schema
object
8 properties
AssistanceListingNumberFilterV1Schema
object
1 property
TopLevelAgencyOppSearchFilterV1Schema
object
1 property
FundingCategoryFilterV1Schema
object
1 property
OpportunitySearchCSVRequestV1Schema
object
3 properties
AwardCeilingFilterV1Schema
object
2 properties
CompetitionAlphaSchema
object
12 properties
OpportunitySearchFilterV1Schema
object
14 properties
ErrorResponseSchema
object
5 properties
FundingInstrumentFilterV1Schema
object
1 property
CompetitionInstructionAlphaSchema
object
4 properties
SortOrderSchema
object
2 properties
OpportunityAssistanceListingV1Schema
object
2 properties
AgencyOppSearchFilterV1Schema
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hhs-opportunity-v1-api-openapi.yml Raw ↑

Other APIs HHS (US Department of Health and Human Services) publishes across the network.

openFDA API
MyHealthfinder API
ONC Health IT Open Data API
HRSA Health Center Data Web Service
HealthData.gov Catalog API
HHS (US Department of Health and Human Services) Agency v1 API
HHS (US Department of Health and Human Services) Application Alpha API
HHS (US Department of Health and Human Services) Award Recommendation Alpha API
HHS (US Department of Health and Human Services) CommonGrants Protocol API
HHS (US Department of Health and Human Services) Competition Alpha API
HHS (US Department of Health and Human Services) Extract v1 API
HHS (US Department of Health and Human Services) File v1 API