Created
March 15, 2018 15:45
-
-
Save russellbodine/60489bbf2a19b893de4ffb450d95acc4 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
## [Spending by Transaction Matview Count](#spending-by-transaction-matview-count) | |
**Route:** `/api/v2/search/spending_by_transaction_matview_count/` | |
**Method:** `POST` | |
This route takes transaction filters, and returns the number of transactions in each award type (Contracts, Loans, Direct Payments, Grants, and Other). | |
### Request | |
filters: Defines how the awards are filtered. The filter object is defined here. | |
https://github.com/fedspendingtransparency/usaspending-api/wiki/Search-Filters-v2-Documentation | |
``` | |
{ | |
"filters": { | |
"award_type_codes": ["10"], | |
"agencies": [ | |
{ | |
"type": "awarding", | |
"tier": "toptier", | |
"name": "Social Security Administration" | |
}, | |
{ | |
"type": "awarding", | |
"tier": "subtier", | |
"name": "Social Security Administration" | |
}, | |
{ | |
"type": "funding", | |
"tier": "toptier", | |
"name": "Social Security Administration" | |
}, | |
{ | |
"type": "funding", | |
"tier": "subtier", | |
"name": "Social Security Administration" | |
} | |
], | |
"legal_entities": [779928], | |
"recipient_scope": "domestic", | |
"recipient_locations": [650597], | |
"recipient_type_names": ["Individual"], | |
"place_of_performance_scope": "domestic", | |
"place_of_performance_locations": [60323], | |
"award_amounts": [ | |
{ | |
"lower_bound": 1500000.00, | |
"upper_bound": 1600000.00 | |
} | |
], | |
"award_ids": [1018950] | |
} | |
} | |
``` | |
### Response (JSON) | |
``` | |
{ | |
"results": { | |
"grants": 0, | |
"loans": 0, | |
"contracts": 0, | |
"direct_payments": 1, | |
"other": 0 | |
} | |
} | |
``` | |
**Response Documentation** | |
The result set always returns how many grants, loans, contracts, direct payments, and other awards are returned with the specified filters. | |
### Errors | |
Possible HTTP Status Codes: | |
* 400 : Missing parameters or limit is not a valid, positive integer | |
* 500 : All other errors | |
``` | |
{ | |
"detail": "Sample error message" | |
} | |
``` |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment