USAspending API ReferenceIndependent
Try the API

Assistance Download

POST/api/v2/download/assistance/
Powers Custom award and account data on usaspending.gov How the Download Center works

Creates a new download job for the requested award and returns a link to a zipped file containing contract award data

Request

curl -X POST 'https://api.usaspending.gov/api/v2/download/assistance/' \
  -H 'Content-Type: application/json' \
  -d '{
  "award_id": "ASST_NON_H79TI081692_7522"
}'

Request body

  • award_idstringRequired

    Example ASST_NON_12FA00PY52375933_12D2

  • file_formatenum (string)

    The format of the file(s) in the zip file containing the data.

    Allowed values
    • csv
    • tsv
    • pstxt

    Default csv

Try it

Runs against the live API. Responses are real data.

POST/api/v2/download/assistance/

Response · 200

  • status_urlstringRequired

    The endpoint used to get the status of a download.

  • file_namestringRequired

    Is the name of the zipfile containing CSVs that will be generated (file_name is timestamp followed by _transactions or _awards).

  • file_urlstringRequired

    The URL for the file.

  • download_requestobjectRequired

    The JSON object used when processing the download.

Example response
{
  "status_url": "http://localhost:8000/api/v2/download/status?file_name=ASST_H79TI081692_2020-01-13_H21M03S28186746.zip",
  "file_name": "ASST_H79TI081692_2020-01-13_H21M03S28186746.zip",
  "file_url": "/csv_downloads/ASST_H79TI081692_2020-01-13_H21M03S28186746.zip",
  "download_request": {
    "account_level": "treasury_account",
    "assistance_id": "H79TI081692",
    "award_id": 69724000,
    "columns": [],
    "download_types": [
      "assistance_federal_account_funding",
      "assistance_transactions",
      "sub_grants"
    ],
    "file_format": "csv",
    "filters": {
      "award_id": 69724000,
      "award_type_codes": [
        "02",
        "06",
        "04",
        "05",
        "08",
        "07",
        "10",
        "03",
        "11",
        "09",
        "F001",
        "F002",
        "F003",
        "F004",
        "F005",
        "F006",
        "F007",
        "F008",
        "F009",
        "F010"
      ]
    },
    "include_data_dictionary": true,
    "include_file_description": {
      "destination": "AssistanceAwardSummary_download_readme.txt",
      "source": "/usaspending-api/usaspending_api/data/AssistanceSummary_download_readme.txt"
    },
    "is_for_assistance": true,
    "is_for_contract": false,
    "is_for_idv": false,
    "limit": 500000,
    "request_type": "assistance"
  }
}

Recent changes

Generated from contracts/v2/download/assistance.md in the USAspending API repo.

Loading…