Route: /api/v2/references/toptier_agencies/
Method: GET
This route sends a request to the backend to retrieve all toptier agencies and related, relevant data.
/api/v2/references/toptier_agencies/?sort=agency_name&order=asc
sort
- OPTIONAL - Optional parameter indicating what value results should be sorted by. Valid options are any of the keys in the JSON objects in the response. Defaults toagency_name
.order
- OPTIONAL - Optional parameter indicating what direction results should be sorted by. Valid options includeasc
for ascending order ordesc
for descending order. Defaults toasc
.
{
"results": [
{
'agency_id': 4,
'agency_name': 'tta_name',
'active_fy': '2017',
'active_fq': '2',
'outlay_amount': 2.00,
'obligated_amount': 2.00,
'budget_authority_amount': 2.00,
'current_total_budget_authority_amount': 3860000000.00,
'percentage_of_total_budget_authority': 1.21231
},
...
]
}
agency_id
: Agency ID. Used as a reference for other endpoints for agency related lookups.agency_name
: Agency nameactive_fy
: most recent fiscal year data is provided for that agencyactive_fq
: most recent fiscal quarter data is provided for that agencyoutlay_amount
: Agency's outlay amountobligated_amount
: Agency's obligated amountbudget_authority_amount
: Agency total budget authoritycurrent_total_budget_authority_amount
: Govenment total budget authority for the respective fiscal yearpercentage_of_total_budget_authority
: budget_authority_amount / currnet_total_budget_amount
Possible HTTP Status Codes:
- 400 : Missing parameters
- 500 : All other errors
{
"detail": "Sample error message"
}