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) Competition Alpha API

The Competition Alpha API from HHS (US Department of Health and Human Services) — 3 operation(s) for competition alpha.

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

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

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

3 operations 3 paths 12 schemas 1 GET2 PUT

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) Competition Alpha 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 3

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

Competition Alpha 3
GET
/alpha/competitions/{competition_id}
Competition Get
1 param → 200401404
PUT
/alpha/competitions/{competition_id}/flag
Update Competition Flag Route
1 param body → 200422401404
PUT
/alpha/competitions/{competition_id}/forms
Put Competition Forms
1 param body → 200422401404

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are FormAlphaSchema (17 properties), CompetitionAlphaSchema (12 properties), ErrorResponseSchema (5 properties), FormInstructionSchema (5 properties). Each schema is shown below with its type and property counts.

FormAlphaSchema
object
17 properties
CompetitionFormAlphaSchema
object
2 properties
CompetitionAlphaSchema
object
12 properties
FormInstructionSchema
object
5 properties
CompetitionFormsSetRequestSchema
object
1 property 1 required
CompetitionFlagUpdateSchema
object
1 property 1 required
CompetitionResponseAlphaSchema
object
3 properties
ErrorResponseSchema
object
5 properties
FormReplaceSchema
object
2 properties 2 required
CompetitionInstructionAlphaSchema
object
4 properties
OpportunityAssistanceListingV1Schema
object
2 properties
ValidationIssueSchema
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hhs-competition-alpha-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) Extract v1 API
HHS (US Department of Health and Human Services) File v1 API
HHS (US Department of Health and Human Services) Form Alpha API