Skip to main content
POST
/
api
/
usaspending
/
recipients
/usaspending/recipients
curl --request POST \
  --url https://api.anysite.io/api/usaspending/recipients \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "recipient_id": "<string>",
  "timeout": 300
}
'
[
  {
    "id": "<string>",
    "@type": "@usaspending_recipient",
    "name": "<string>",
    "alternate_names": [],
    "duns": "<string>",
    "uei": "<string>",
    "parent_id": "<string>",
    "parent_name": "<string>",
    "parent_duns": "<string>",
    "parent_uei": "<string>",
    "parents": [],
    "business_types": [],
    "location": {
      "@type": "@usaspending_recipient_location",
      "address_line1": "<string>",
      "address_line2": "<string>",
      "address_line3": "<string>",
      "city_name": "<string>",
      "county_name": "<string>",
      "state_code": "<string>",
      "zip5": "<string>",
      "zip4": "<string>",
      "foreign_postal_code": "<string>",
      "foreign_province": "<string>",
      "country_name": "<string>",
      "country_code": "<string>",
      "congressional_code": "<string>"
    },
    "total_transaction_amount": 123,
    "total_transactions": 123,
    "total_face_value_loan_amount": 123,
    "total_face_value_loan_transactions": 123
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
recipient_id
string
required

Recipient identifier (UUID with a level suffix -R, -P or -C)

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}-[RPC]$
Examples:

"b97d19b0-833c-8d8f-3a2c-157d04ea55ef-P"

"b97d19b0-833c-8d8f-3a2c-157d04ea55ef-C"

timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

id
string
required
@type
string
default:@usaspending_recipient
name
string | null
alternate_names
string[]
duns
string | null
uei
string | null
recipient_level
enum<string> | null
Available options:
R,
P,
C
parent_id
string | null
parent_name
string | null
parent_duns
string | null
parent_uei
string | null
parents
UsaspendingRecipientParent · object[]
business_types
string[]
location
UsaspendingRecipientLocation · object
total_transaction_amount
number | null
total_transactions
integer | null
total_face_value_loan_amount
number | null
total_face_value_loan_transactions
integer | null