USAspending API ReferenceIndependent
Try the API

Recipient Spending Disaster/Emergency Funding via Loans

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

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

Returns loan spending details of recipients receiving supplemental funding budgetary resources

Request

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

Request body

  • filterobject · FilterRequired3 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.

    • award_type_codesarray of string

      Only accepts loan award type 07 or 08 in the array, since this endpoint is specific to loans

      Default ["07", "08"]

      Example ["07","08"]

    • 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
      • description
      • award_count
      • face_value_of_loan
      • obligation
      • outlay

      Default description

Try it

Runs against the live API. Responses are real data.

POST/api/v2/disaster/recipient/loans/

Response · 200

  • totalsobject · TotalsRequired4 fields
    • award_countnumberRequired
    • face_value_of_laonnumberRequired
    • obligationnumberRequired
    • outlaynumberRequired
  • resultsarray of ResultRequired8 fields
    • idarray of stringRequired
    • 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_laon": "37369840.0",
    "obligation": 364037369840.58,
    "outlay": 290416885040.71
  },
  "results": [
    {
      "code": "987654321",
      "award_count": 2,
      "description": "RECIPIENT 3",
      "face_value_of_loan": 100,
      "id": [
        "d2894d22-67fc-f9cb-4005-33fa6a29ef86-C",
        "d2894d22-67fc-f9cb-4005-33fa6a29ef86-R"
      ],
      "obligation": 2200,
      "outlay": 1100
    },
    {
      "code": "456789123",
      "award_count": 1,
      "description": "RECIPIENT 2",
      "face_value_of_loan": 200,
      "id": [
        "3c92491a-f2cd-ec7d-294b-7daf91511866-R"
      ],
      "obligation": 20,
      "outlay": 0
    }
  ],
  "page_metadata": {
    "page": 1,
    "next": 2,
    "previous": null,
    "hasNext": true,
    "hasPrevious": false,
    "total": 23,
    "limit": 2
  }
}

Recent changes

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

Loading…