IDV Activity

POST/api/v2/idvs/activity/

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

This endpoint is used to power the IDV (Indefinite Delivery Vehicle) Activity visualization on IDV Summary Pages.

List child and grandchild awards for a given IDV

Request

curl -X POST 'https://api.usaspending.gov/api/v2/idvs/activity/' \
  -H 'Content-Type: application/json' \
  -d '{
  "award_id": "CONT_IDV_TMHQ10C0040_2044",
  "page": 1,
  "hide_edge_cases": true,
  "limit": 50
}'

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_V509P6176_3600
limitnumber
The number of results to include per page.
Default 10
pagenumber
The page of results to return based on the limit.
Default 1
hide_edge_casesboolean
Choose whether or not to hide awards that have no/negative obligated amounts and/or no/negative awarded amounts and/or no end date
Default false

Try it

Runs against the live API. Responses are real data.

POST/api/v2/idvs/activity/

Request body

Response · 200

resultsarray of ChildAwardRequired16 fields
Results are sorted by obligated amount in descending order.
- award_idnumberRequired
  Unique internal surrogate identifier for an award. Deprecated. Use generated_unique_award_id.
- generated_unique_award_idstringRequired
  Unique internal natural identifier for an award.
- awarding_agencystringRequired
- awarding_agency_idnumberRequired
- awarding_agency_slugstringRequiredNullable
  agency_slug is a string used to generate a link to the agency profile page. Will be NULL if the agency does not have a profile page.
- period_of_performance_potential_end_datestringRequiredNullable
- parent_award_idnumberRequiredNullable
  Internal, surrogate id for the award's parent. Deprecated. Use parent_generated_unique_award_id.
- parent_generated_unique_award_idstringRequiredNullable
  Unique internal natural identifier for the award's parent.
- parent_award_piidstringRequiredNullable
- obligated_amountnumberRequired
- awarded_amountnumberRequired
- period_of_performance_start_datestringRequiredNullable
  The starting date of the award in the format YYYY-MM-DD
- piidstringRequired
  Procurement Instrument Identifier (PIID).
- recipient_namestringRequiredNullable
- recipient_idstringRequiredNullable
- grandchildbooleanRequired
page_metadataobject · PageMetaDataRequired7 fields
- hasNextbooleanRequired
- hasPreviousbooleanRequired
- limitnumberRequired
- nextnumberRequiredNullable
- pagenumberRequired
- previousnumberRequiredNullable
- totalnumberRequired
  Total count of all results including those not returned on this page.

Example response

{
  "results": [
    {
      "award_id": 1867804,
      "awarding_agency": "Department of Veterans Affairs",
      "awarding_agency_id": 561,
      "awarding_agency_slug": "department-of-veterans-affairs",
      "generated_unique_award_id": "CONT_AWD_00509200110C509C25044V509P6176_3600_V509P6176_3600",
      "period_of_performance_potential_end_date": "2003-09-15 00:00:00",
      "parent_award_id": 69001298,
      "parent_generated_unique_award_id": "CONT_IDV_V509P6176_3600",
      "parent_award_piid": "V509P6176",
      "obligated_amount": 30000,
      "awarded_amount": 0,
      "period_of_performance_start_date": "2001-10-15",
      "piid": "00509200110C509C25044V509P6176",
      "recipient_name": "SIEMENS MEDICAL SOLUTIONS USA INCORPORATED",
      "recipient_id": "b5e31cf9-1f2f-dee0-7f70-eb73fd55617a-C",
      "grandchild": false
    },
    {
      "award_id": 1867504,
      "awarding_agency": "Department of Veterans Affairs",
      "awarding_agency_id": 561,
      "awarding_agency_slug": "department-of-veterans-affairs",
      "generated_unique_award_id": "CONT_AWD_00509200010C509C15099V509P6176_3600_V509P6176_3600",
      "period_of_performance_potential_end_date": "2003-09-15 00:00:00",
      "parent_award_id": 69001298,
      "parent_generated_unique_award_id": "CONT_IDV_V509P6176_3600",
      "parent_award_piid": "V509P6176",
      "obligated_amount": 30000,
      "awarded_amount": 0,
      "period_of_performance_start_date": "2000-10-15",
      "piid": "00509200010C509C15099V509P6176",
      "recipient_name": "SIEMENS MEDICAL SOLUTIONS USA INCORPORATED",
      "recipient_id": "b5e31cf9-1f2f-dee0-7f70-eb73fd55617a-C",
      "grandchild": false
    },
    {
      "award_id": 1867181,
      "awarding_agency": "Department of Veterans Affairs",
      "awarding_agency_id": 561,
      "awarding_agency_slug": "department-of-veterans-affairs",
      "generated_unique_award_id": "CONT_AWD_00509199910C509C05018V509P6176_3600_V509P6176_3600",
      "period_of_performance_potential_end_date": "2003-09-15 00:00:00",
      "parent_award_id": 69001298,
      "parent_generated_unique_award_id": "CONT_IDV_V509P6176_3600",
      "parent_award_piid": "V509P6176",
      "obligated_amount": 30000,
      "awarded_amount": 0,
      "period_of_performance_start_date": "1999-10-15",
      "piid": "00509199910C509C05018V509P6176",
      "recipient_name": "SIEMENS MEDICAL SOLUTIONS USA INCORPORATED",
      "recipient_id": "b5e31cf9-1f2f-dee0-7f70-eb73fd55617a-C",
      "grandchild": false
    }
  ],
  "page_metadata": {
    "hasNext": false,
    "hasPrevious": false,
    "limit": 10,
    "next": null,
    "page": 1,
    "previous": null,
    "total": 3
  }
}

Recent changes

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

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