USAspending API ReferenceIndependent
Try the API

Agencies Spending Disaster/Emergency Funding via Loans

POST/api/v2/disaster/object_class/loans/
Powers COVID-19 spending on usaspending.gov

This endpoint provides insights on the Object Classes' loans from disaster/emergency funding per the requested filters.

Returns loan spending details of Object Classes receiving supplemental funding budgetary resources

Request

curl -X POST 'https://api.usaspending.gov/api/v2/disaster/object_class/loans/' \
  -H 'Content-Type: application/json' \
  -d '{
  "filter": {
    "def_codes": [
      "L",
      "M",
      "N",
      "O",
      "P",
      "U"
    ]
  },
  "pagination": {
    "limit": 10,
    "page": 1,
    "sort": "award_count",
    "order": "desc"
  },
  "spending_type": "total"
}'

Request body

  • filterobject · FilterRequired2 fields
    • def_codesarray of DEFCRequired

      List of Disaster Emergency Fund (DEF) Codes (DEFC) defined by legislation at the time of writing. When filtering on award_type_codes this will filter on File D records that have at least one File C with the provided DEFC and belong to CARES Act DEFC. A list of current DEFC can be found here.

    • querystring

      A "keyword" or "search term" to filter down results based on this text snippet

  • paginationobject · Pagination4 fields
    • pagenumber

      Requested page of results

      Default 1

    • limitnumber

      Page Size of results

      Default 10

    • orderenum (string)

      Indicates what direction results should be sorted by. Valid options include asc for ascending order or desc for descending order.

      Allowed values
      • desc
      • asc

      Default desc

    • sortenum (string)

      Optional parameter indicating what value results should be sorted by

      Allowed values
      • id
      • code
      • description
      • award_count
      • face_value_of_loan
      • obligation
      • outlay

      Default id

Try it

Runs against the live API. Responses are real data.

POST/api/v2/disaster/object_class/loans/

Response · 200

  • totalsobject · TotalsRequired4 fields
    • award_countnumberRequiredNullable
    • face_value_of_loannumberRequired
    • obligationnumberRequired
    • outlaynumberRequired
  • resultsarray of ResultRequired8 fields
    • idstringRequired
    • codestringRequired
    • descriptionstringRequired
    • childrenarray of Result
    • award_countnumberRequired
    • face_value_of_loannumberRequiredNullable
    • obligationnumberRequiredNullable
    • outlaynumberRequiredNullable
  • page_metadataobject · PageMetadataRequired7 fields
    • pagenumberRequired
    • nextnumberRequiredNullable
    • previousnumberRequiredNullable
    • hasNextbooleanRequired
    • hasPreviousbooleanRequired
    • totalnumberRequired
    • limitnumberRequired
Example response
{
  "totals": {
    "award_count": 4574,
    "face_value_of_loan": 290416885040.71,
    "obligation": 364037369840.58,
    "outlay": 290416885040.71
  },
  "results": [
    {
      "id": "43",
      "code": "090",
      "description": "Description text of 090, for humans",
      "children": [],
      "award_count": 54,
      "face_value_of_loan": 89.01,
      "obligation": 4324,
      "outlay": 29
    },
    {
      "id": "41",
      "code": "012",
      "description": "Description text of 012, for humans",
      "children": [],
      "award_count": 2,
      "face_value_of_loan": 50,
      "obligation": 44323,
      "outlay": 746
    }
  ],
  "page_metadata": {
    "page": 1,
    "next": 2,
    "previous": null,
    "hasNext": true,
    "hasPrevious": false,
    "total": 23,
    "limit": 2
  }
}

Recent changes

Generated from contracts/v2/disaster/object_class/loans.md in the USAspending API repo.

Loading…