IDV Related Awards

POST/api/v2/idvs/awards/

Powers Award summaries on usaspending.gov How an award summary is built

List child IDVs, child awards, or grandchild awards for IDV

Request

curl -X POST 'https://api.usaspending.gov/api/v2/idvs/awards/' \
  -H 'Content-Type: application/json' \
  -d '{
  "award_id": "CONT_IDV_TMHQ10C0040_2044",
  "type": "child_awards",
  "limit": 10,
  "page": 1,
  "sort": "period_of_performance_start_date",
  "order": "desc"
}'

Request body

award_idstringRequired
Either a "generated" natural award id (string) or a database surrogate award id (number). Generated award identifiers are preferred as they are effectively permanent. Surrogate award ids are retained for backward compatibility but are deprecated.
Example CONT_IDV_GS23F0170L_4730
typeenum (string)
The type of related awards to return.
Allowed values
- child_idvs
- child_awards
- grandchild_awards
Default child_idvs
limitnumber
The number of results to include per page.
Default 10
Example 5
pagenumber
The page of results to return based on the limit.
Default 1
Example 1
sortenum (string)
The field results are sorted by.
Allowed values
- period_of_performance_start_date
- piid
- description
- period_of_performance_current_end_date
- last_date_to_order
- funding_agency
- awarding_agency
- award_type
- obligated_amount
Default period_of_performance_start_date
orderstring
The direction results are sorted by. asc for ascending, desc for descending.
Default desc
Example desc

Try it

Runs against the live API. Responses are real data.

POST/api/v2/idvs/awards/

Request body

Response · 200

resultsarray of IDVRelatedAwardsResponseRequired15 fields
- award_idnumberRequired
  Unique internal surrogate identifier for an award. Deprecated. Use generated_unique_award_id.
  Example 69054107
- award_typestringRequired
  Example BPA
- descriptionstringRequiredNullable
  Example OTHER THAN SCHEDULE,IGF::OT::IGF
- funding_agencystringRequiredNullable
  Example GENERAL SERVICES ADMINISTRATION (GSA)
- awarding_agencystringRequiredNullable
  Example GENERAL SERVICES ADMINISTRATION (GSA)
- funding_agency_idnumberRequiredNullable
  Example 634
- awarding_agency_idnumberRequiredNullable
  Example 634
- funding_agency_slugstringRequiredNullable
  funding_agency_slug is a string used to generate a link to the funding agency's profile page. Will be NULL if the funding agency does not have a profile page.
  Example general-services-administration-gsa
- awarding_agency_slugstringRequiredNullable
  awarding_agency_slug is a string used to generate a link to the awarding agency's profile page. Will be NULL if the awarding agency does not have a profile page.
  Example general-services-administration-gsa
- generated_unique_award_idstringRequired
  Unique internal natural identifier for an award.
  Example CONT_IDV_DJB30605051_1540
- last_date_to_orderstringRequiredNullable
  Example 2017-09-30
- obligated_amountnumberRequired
  Example 22570355.24
- period_of_performance_current_end_datestringRequiredNullable
  The ending date of the award in the format YYYY-MM-DD
  Example 2015-02-19
- period_of_performance_start_datestringRequiredNullable
  The starting date of the award in the format YYYY-MM-DD
  Example 2014-10-01
- piidstringRequired
  Procurement Instrument Identifier (PIID).
  Example GS33FCA001
page_metadataobject · PageMetaDataObjectRequired5 fields
- pagenumberRequired
  Example 2
- hasNextbooleanRequired
  Example false
- hasPreviousbooleanRequired
  Example false
- nextnumberRequiredNullable
  Example 3
- previousnumberRequiredNullable
  Example 1

Example response

{
    "results": [
        {
            "award_id": 69138778,
            "award_type": "BPA",
            "description": "IGF::OT::IGF GP-2600 FEDEX SHIPPING SERVICE - GREAT PLAINS REGIONAL OFFICE, BILLINGS, MONTANA",
            "funding_agency": "DEPARTMENT OF THE INTERIOR",
            "awarding_agency": "DEPARTMENT OF THE INTERIOR",
            "funding_agency_id": 228,
            "awarding_agency_id": 228,
            "funding_agency_slug": "department-of-the-interior",
            "awarding_agency_slug": "department-of-the-interior",
            "generated_unique_award_id": "CONT_IDV_INR17PA00008_1425",
            "last_date_to_order": "2020-11-30",
            "obligated_amount": 8000.0,
            "period_of_performance_current_end_date": null,
            "period_of_performance_start_date": "2016-01-14",
            "piid": "INR17PA00008"
        },
        {
            "award_id": 69054107,
            "award_type": "BPA",
            "description": "OTHER THAN SCHEDULE,IGF::OT::IGF",
            "funding_agency": "GENERAL SERVICES ADMINISTRATION",
            "awarding_agency": "GENERAL SERVICES ADMINISTRATION",
            "funding_agency_id": 634,
            "awarding_agency_id:: 634,
            "funding_agency_slug": "general-services-administration",
            "awarding_agency_slug": "general-services-administration",
            "generated_unique_award_id": "CONT_IDV_GS33FCA001_4732",
            "last_date_to_order": "2017-09-30",
            "obligated_amount": 22570355.24,
            "period_of_performance_current_end_date": null,
            "period_of_performance_start_date": "2014-10-01",
            "piid": "GS33FCA001"
        },
        {
            "award_id": 69216438,
            "award_type": "BPA",
            "description": "IGF::OT::IGF BPA WITH AN INTERNATIONAL MAIL DELIVERY SERVICE FOR PACKAGES GENERATED THROUGH TSED'S COCHRAN FELLOWSHIP PROGRAM",
            "funding_agency": "DEPARTMENT OF AGRICULTURE",
            "awarding_agency": "DEPARTMENT OF AGRICULTURE",
            "funding_agency_id": 153,
            "awarding_agency_id": 153,
            "funding_agency_slug": "department-of-agriculture",
            "awarding_agency_slug": "department-of-agriculture",
            "generated_unique_award_id": "CONT_IDV_AG3151B140009_12D2",
            "last_date_to_order": "2015-04-06",
            "obligated_amount": 47840.0,
            "period_of_performance_current_end_date": null,
            "period_of_performance_start_date": "2014-04-07",
            "piid": "AG3151B140009"
        }
    ],
    "page_metadata": {
        "hasNext": true,
        "hasPrevious": false,
        "next": 2,
        "page": 1,
        "previous": null
    }
}

Recent changes

No contract changes to this endpoint since October 2024. The changelog covers every endpoint.

Generated from contracts/v2/idvs/awards.md in the USAspending API repo.