/usaspending/awards/transactions

POST /api/usaspending/awards/transactions

Price: 1 credit

List the transactions (modifications) of a federal award

How to use it

List the transactions of a U.S. federal award by its award identifier. Each transaction is a single action or modification on the award — action date and type, modification number, description, the federal obligation amount, loan guarantee and subsidy values, and the CFDA program number for assistance awards. Transactions trace how an award changed over its life.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• award string required — Award identifier (generated unique award id) (examples: "CONT_AWD_N0001920C0009_9700_-NONE-_-NONE-", "ASST_NON_2405CA5MAP_075"; minLength: 1)
• count integer required — Number of transactions to return (min: 1)
• sort string — Field to sort transactions by (default: "action_date"; one of: "action_date", "modification_number", "federal_action_obligation", "face_value_loan_guarantee")
• order string — Sort direction (default: "desc"; one of: "asc", "desc")

Response

• @type string (default: "UsaspendingTransaction")
• id string required
• type string nullable
• type_description string nullable
• action_date string nullable
• action_type string nullable
• action_type_description string nullable
• modification_number string nullable
• description string nullable
• federal_action_obligation number nullable
• face_value_loan_guarantee number nullable
• original_loan_subsidy_cost number nullable
• cfda_number string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Award not found or has no transactions Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.