Skip to main content
POST
/
api
/
usaspending
/
awards
/
search
/usaspending/awards/search
curl --request POST \
  --url https://api.anysite.io/api/usaspending/awards/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "keywords": [
    "<string>"
  ],
  "award_type_codes": [],
  "count": 2,
  "timeout": 300,
  "start_date": "<string>",
  "end_date": "<string>",
  "sort": "Award Amount",
  "order": "desc"
}
'
import requests

url = "https://api.anysite.io/api/usaspending/awards/search"

payload = {
"keywords": ["<string>"],
"award_type_codes": [],
"count": 2,
"timeout": 300,
"start_date": "<string>",
"end_date": "<string>",
"sort": "Award Amount",
"order": "desc"
}
headers = {
"access-token": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
keywords: ['<string>'],
award_type_codes: [],
count: 2,
timeout: 300,
start_date: '<string>',
end_date: '<string>',
sort: 'Award Amount',
order: 'desc'
})
};

fetch('https://api.anysite.io/api/usaspending/awards/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.anysite.io/api/usaspending/awards/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'keywords' => [
'<string>'
],
'award_type_codes' => [

],
'count' => 2,
'timeout' => 300,
'start_date' => '<string>',
'end_date' => '<string>',
'sort' => 'Award Amount',
'order' => 'desc'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"access-token: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.anysite.io/api/usaspending/awards/search"

payload := strings.NewReader("{\n \"keywords\": [\n \"<string>\"\n ],\n \"award_type_codes\": [],\n \"count\": 2,\n \"timeout\": 300,\n \"start_date\": \"<string>\",\n \"end_date\": \"<string>\",\n \"sort\": \"Award Amount\",\n \"order\": \"desc\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.anysite.io/api/usaspending/awards/search")
.header("access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"keywords\": [\n \"<string>\"\n ],\n \"award_type_codes\": [],\n \"count\": 2,\n \"timeout\": 300,\n \"start_date\": \"<string>\",\n \"end_date\": \"<string>\",\n \"sort\": \"Award Amount\",\n \"order\": \"desc\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.anysite.io/api/usaspending/awards/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"keywords\": [\n \"<string>\"\n ],\n \"award_type_codes\": [],\n \"count\": 2,\n \"timeout\": 300,\n \"start_date\": \"<string>\",\n \"end_date\": \"<string>\",\n \"sort\": \"Award Amount\",\n \"order\": \"desc\"\n}"

response = http.request(request)
puts response.read_body
[
  {
    "id": "<string>",
    "@type": "UsaspendingAwardSearchResult",
    "internal_id": 123,
    "award_id": "<string>",
    "recipient_name": "<string>",
    "recipient_id": "<string>",
    "award_amount": 123,
    "total_outlay": 123,
    "award_type": "<string>",
    "awarding_agency": "<string>",
    "awarding_sub_agency": "<string>",
    "funding_agency": "<string>",
    "funding_sub_agency": "<string>",
    "start_date": "<string>",
    "end_date": "<string>",
    "last_modified_date": "<string>",
    "agency_slug": "<string>"
  }
]
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
keywords
string[]
required
Minimum array length: 1
award_type_codes
enum<string>[]
required
Minimum array length: 1
Available options:
A,
B,
C,
D,
IDV_A,
IDV_B,
IDV_B_A,
IDV_B_B,
IDV_B_C,
IDV_C,
IDV_D,
IDV_E,
02,
03,
04,
05,
06,
07,
08,
09,
10,
11
count
integer
required
Required range: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
start_date
string | null
end_date
string | null
sort
enum<string>
default:Award Amount
Available options:
Award Amount,
Total Outlays,
Start Date,
End Date,
Recipient Name,
Award ID,
Last Modified Date,
Awarding Agency
order
enum<string>
default:desc
Available options:
asc,
desc

Response

Successful Response

id
string
required
@type
string
default:UsaspendingAwardSearchResult
internal_id
integer | null
award_id
string | null
recipient_name
string | null
recipient_id
string | null
award_amount
number | null
total_outlay
number | null
award_type
string | null
awarding_agency
string | null
awarding_sub_agency
string | null
funding_agency
string | null
funding_sub_agency
string | null
start_date
string | null
end_date
string | null
last_modified_date
string | null
agency_slug
string | null