List awards | DefDex Developer Documentation

{
  "data": [
    {
      "id": "CONT_AWD_N0001917C0001_9700_-NONE-_-NONE-",
      "url": "string",
      "source_url": "string",
      "title": "string",
      "piid": "string",
      "parent_piid": "string",
      "recipient": {
        "id": "string",
        "name": "string"
      },
      "recipient_uei": "string",
      "parent_company": {
        "id": "string",
        "name": "string"
      },
      "agency": {
        "id": "string",
        "name": "string"
      },
      "office": {
        "id": "string",
        "name": "string"
      },
      "program": {
        "id": "string",
        "name": "string"
      },
      "obligated_usd": 1.1,
      "current_value_usd": 1.1,
      "announced_ceiling_usd": 1.1,
      "actions": 1,
      "first_action_on": "2023-01-15",
      "last_action_on": "2023-01-15",
      "end_on": "2023-01-15",
      "potential_end_on": "2023-01-15",
      "award_type_code": "string",
      "product_service_code": "string",
      "naics_code": "string",
      "place_of_performance": {
        "city": "string",
        "state": "string",
        "country": "string"
      },
      "totals": {},
      "transactions": {}
    }
  ],
  "next_cursor": "string",
  "build_id": "string",
  "truncated": true,
  "bulk": {
    "message": "string",
    "email": "string",
    "contact_url": "string"
  }
}

Federal awards, largest obligation first (sort=date for newest). Needs recipient, agency, program, naics or psc. agency includes everything under it. 1 credit per page. At most 1,000 results per query; past that the page says truncated and points to hello@defdex.io for bulk data.

Authentication

AuthorizationBearer

Create a key at https://app.defdex.io/developer/keys. Keep it private.

Query parameters

recipientstringOptional<=200 characters

Organization id or slug; includes awards to its subsidiaries.

agencystringOptional<=200 characters

Agency or office id or slug, including its sub-organizations and offices.

programstringOptional<=200 characters

Program id or slug, including its child codes.

naicsstringOptionalformat: "^\d{2,6}$"

NAICS code or prefix (2–6 digits).

pscstringOptional<=4 characters

Product or service code or prefix.

qstringOptional<=200 characters

Award title contains this text.

fiscal_yearintegerOptional2000-2100

Federal fiscal year the award started (Oct 1 – Sep 30).

statestringOptional=2 characters

Place-of-performance state (two letters).

min_obligated_usdintegerOptional>=0

Only awards with at least this much obligated.

sortenumOptional

amount (default) or date.

Allowed values:

limitintegerOptional1-100Defaults to 25

Results per page, 1–100 (default 25). Each page costs 1 credit.

cursorstringOptional<=4000 characters

next_cursor from the previous page. Keep the other parameters unchanged.

Response headers

X-Request-IdstringOptional

Support identifier on admitted requests.

X-Credits-RemainingstringOptional

Credits left after this call.

Response

Success

datalist of objects

next_cursorstring or null

build_idstring

The published build this page came from.

truncatedbooleanOptional

True when more than 1,000 results match. Narrow the filters, or email hello@defdex.io for a bulk dataset.

bulkobjectOptional

Present when a query hits the 1,000-result cap or has no filter.

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

429

Too Many Requests Error

503

Service Unavailable Error