IDV Funding

Request

curl -X POST 'https://api.usaspending.gov/api/v2/idvs/funding/' \
  -H 'Content-Type: application/json' \
  -d '{
  "award_id": "CONT_IDV_TMHQ10C0040_2044",
  "page": 1,
  "sort": "piid",
  "order": "asc",
  "limit": 15
}'

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

• piidstring

  Award ID to further refine results. All File C financial data for this award is returned if omitted.

  Example 15B30518FTM230002

• limitnumber

  The number of results to include per page.

  Default 10

  Example 5

• pagenumber

  The page of results to return based on limit.

  Default 1

  Example 1

• sortenum (string)

  The field on which to order results.

  Allowed values

  • account_title
  • disaster_emergency_fund_code
  • gross_outlay_amount
  • object_class Object class code, object class name
  • piid
  • program_activity Program activity name, program activity code
  • reporting_agency_name
  • reporting_fiscal_date Reporting fiscal year, reporting fiscal month
  • transaction_obligated_amount

  Default reporting_fiscal_date

• orderenum (string)

  The direction in which to order results. asc for ascending or desc for descending.

  Allowed values

  • asc
  • desc

  Default desc

Response · 200

• resultsarray of IDVFundingResponseRequired25 fields

  • award_idnumberRequired

    Unique internal surrogate identifier for an award. Deprecated. Use generated_unique_award_id.

    Example 5531118

  • generated_unique_award_idstringRequired

    Unique internal natural identifier for an award.

    Example CONT_AWD_15B30518FTM230002_1540_GS23F0170L_4730

  • reporting_fiscal_yearnumberRequiredNullable

    Fiscal year of the submission date.

    Example 2018

  • reporting_fiscal_quarternumberRequiredNullable

    Fiscal quarter of the submission date.

    Example 3

  • reporting_fiscal_monthnumberRequiredNullable

    Fiscal month of the submission date.

  • is_quarterly_submissionbooleanRequiredNullable

    True if the submission is quarterly. False if the submission is monthly.

  • disaster_emergency_fund_codebooleanRequiredNullable

    Code indicating whether or not the funding record is associated with a disaster.

  • piidstringRequiredNullable

    Procurement Instrument Identifier (PIID).

    Example 15B30518FTM230002

  • awarding_agency_idnumberRequiredNullable

    Internal surrogate identifier of the awarding agency.

    Example 252

  • awarding_toptier_agency_idnumberRequiredNullable
  • awarding_agency_slugstringRequiredNullable
  • awarding_agency_namestringRequiredNullable

    Example Department of Justice

  • funding_agency_idnumberRequiredNullable

    Internal surrogate identifier of the funding agency.

    Example 252

  • funding_toptier_agency_idnumberRequiredNullable
  • funding_agency_slugstringRequiredNullable
  • funding_agency_namestringRequiredNullable

    Example Department of Justice

  • agency_idstringRequiredNullable

    CGAC of the funding agency.

    Example 015

  • main_account_codestringRequiredNullable

    Example 1060

  • account_titlestringRequiredNullable

    Federal Account Title

    Example Salaries and Expenses, Federal Prison System, Justice

  • program_activity_codestringRequiredNullable

    Example 0002

  • program_activity_namestringRequiredNullable

    Example INSTITUTION SECURITY AND ADMINISTRATION

  • object_classstringRequiredNullable

    Example 220

  • object_class_namestringRequiredNullable

    Example Transportation of things

  • transaction_obligated_amountnumberRequiredNullable

    Example 193.96

  • gross_outlay_amountnumberRequiredNullable

    Example 792.9

• page_metadataobject · PageMetaDataObjectRequired5 fields

  • pagenumberRequired

    Example 2

  • hasNextbooleanRequired

    Example false

  • hasPreviousbooleanRequired

    Example false

  • nextnumberRequiredNullable

    Example 3

  • previousnumberRequiredNullable

    Example 1

{
  "results": [
    {
      "award_id": 9338979,
      "generated_unique_award_id": "CONT_AWD_AG3A94K160035_12G2_GS33FCA001_4732",
      "reporting_fiscal_year": 2017,
      "reporting_fiscal_quarter": 4,
      "reporting_fiscal_month": 12,
      "is_quarterly_submission": true,
      "disaster_emergency_fund_code": null,
      "piid": "AG3A94K160035",
      "awarding_agency_id": 166,
      "awarding_toptier_agency_id": 123,
      "awarding_agency_slug": "department-of-agriculture",
      "awarding_agency_name": "Department of Agriculture",
      "funding_agency_id": 166,
      "funding_toptier_agency_id": 123,
      "funding_agency_slug": "department-of-agriculture",
      "funding_agency_name": "Department of Agriculture",
      "agency_id": "012",
      "main_account_code": "3700",
      "account_title": "Food Safety and Inspection Service, Agriculture",
      "program_activity_code": "0001",
      "program_activity_name": "SALARIES AND EXPENSES",
      "object_class": "220",
      "object_class_name": "Transportation of things",
      "transaction_obligated_amount": 680000,
      "gross_outlay_amount": 0
    },
    {
      "award_id": 9338979,
      "generated_unique_award_id": "CONT_AWD_AG3A94K160035_12G2_GS33FCA001_4732",
      "reporting_fiscal_year": 2017,
      "reporting_fiscal_quarter": 3,
      "reporting_fiscal_month": 9,
      "is_quarterly_submission": true,
      "disaster_emergency_fund_code": null,
      "piid": "AG3A94K160035",
      "awarding_agency_id": 166,
      "awarding_toptier_agency_id": 123,
      "awarding_agency_slug": "department-of-agriculture",
      "awarding_agency_name": "Department of Agriculture",
      "funding_agency_id": 166,
      "funding_toptier_agency_id": 123,
      "funding_agency_slug": "department-of-agriculture",
      "funding_agency_name": "Department of Agriculture",
      "agency_id": "012",
      "main_account_code": "3700",
      "account_title": "Food Safety and Inspection Service, Agriculture",
      "program_activity_code": "0001",
      "program_activity_name": "SALARIES AND EXPENSES",
      "object_class": "220",
      "object_class_name": "Transportation of things",
      "transaction_obligated_amount": 680000,
      "gross_outlay_amount": 0
    }
  ],
  "page_metadata": {
    "page": 1,
    "next": 2,
    "previous": null,
    "hasNext": true,
    "hasPrevious": false
  }
}

Recent changes

• August 7, 2020Mentioned in the August 07, 2020 release notes

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