USAspending API ReferenceIndependent
Try the API

Bulk Download Status

GET/api/v2/bulk_download/status
Powers Award data archive on usaspending.gov How the Download Center works

This route gets the current status of a download job.

Request

curl 'https://api.usaspending.gov/api/v2/bulk_download/status'

Try it

Runs against the live API. Responses are real data.

GET/api/v2/bulk_download/status

Response · 200

  • file_namestringRequired

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

  • messagestringRequiredNullable

    A human readable error message if the status is failed, otherwise it is null.

  • seconds_elapsedstringRequiredNullable

    Is the time taken to genereate the file (if status is finished or failed), or time taken so far (if running).

  • statusenum (string)Required

    A string representing the current state of the CSV generation request.

    Allowed values
    • failed
    • finished
    • ready
    • running
  • total_columnsnumberRequiredNullable

    Is the number of columns in the CSV, or null if not finished.

  • total_rowsnumberRequiredNullable

    Is the number of rows in the CSV, or null if not finished.

  • total_sizenumberRequiredNullable

    Is the estimated file size of the CSV in kilobytes, or null if not finished.

  • file_urlstringRequired

    The URL for the file.

Example response
{
  "status": "finished",
  "message": null,
  "file_name": "012_PrimeTransactions_2020-01-13_H20M58S34486877.zip",
  "file_url": "/usaspending-api/csv_downloads/012_PrimeTransactions_2020-01-13_H20M58S34486877.zip",
  "total_size": 3.169,
  "total_columns": 276,
  "total_rows": 0,
  "seconds_elapsed": "4.145662"
}

Recent changes

Generated from contracts/v2/bulk_download/status.md in the USAspending API repo.

Loading…