USAspending API ReferenceIndependent
Try the API

Glossary Autocomplete

POST/api/v2/autocomplete/glossary/

This endpoint returns glossary autocomplete data for submitted text snippet.

List Autocomplete Glossary

Request

curl -X POST 'https://api.usaspending.gov/api/v2/autocomplete/glossary/' \
  -H 'Content-Type: application/json' \
  -d '{
  "search_text": "Award"
}'

Request body

  • search_textstringRequired

    The text snippet that you are trying to autocomplete using a glossary term.

  • limitnumber

    Number of results to return (min: 1, max: 500)

    Default 10

Try it

Runs against the live API. Responses are real data.

POST/api/v2/autocomplete/glossary/

Response · 200

  • resultsarray of stringRequired
  • countnumberRequired
  • search_textstringRequired
  • matched_termsarray of GlossaryListingRequired6 fields
    • termstringRequired
    • slugstringRequired
    • data_act_termstringRequiredNullable
    • plainstringRequired
    • officialstringRequiredNullable
    • resourcesstringRequiredNullable
Example response
{
  "results": [
    "Award",
    "Award Amount",
    "Award ID",
    "Award Type",
    "Awarding Agency",
    "Awarding Office",
    "Awarding Sub-Agency",
    "Current Award Amount",
    "Multiple Award Schedule (MAS)",
    "Parent Award Identification (ID) Number"
  ],
  "search_text": "aW",
  "count": 10,
  "matched_terms": [
    {
      "term": "Award",
      "slug": "award",
      "data_act_term": null,
      "plain": "Money the federal government has promised to pay a recipient. Funding may be awarded to a company, organization, government entity (i.e., state, local, tribal, federal, or foreign), or individual. It may be obligated (promised) in the form of a contract, grant, loan, insurance, direct payment, etc.",
      "official": null,
      "resources": null
    },
    {
      "term": "Award Amount",
      "slug": "award-amount",
      "data_act_term": "Amount of Award",
      "plain": "The amount that the federal government has promised to pay (obligated) a recipient, because it has signed a contract, awarded a grant, etc. ",
      "official": "The cumulative amount obligated by the Federal Government for an award, which is calculated by USAspending.gov.\n\nFor procurement and financial assistance awards except loans, this is the sum of Federal Action Obligations.\n\nFor loans or loan guarantees, this is the Original Subsidy Cost.",
      "resources": "See also:\n\n- [Federal Action Obligation](?glossary=federal-action-obligation)\n- [Subsidy Cost](?glossary=subsidy-cost)\n- [Current Total Value of Award](?glossary=current-award-amount)"
    }
  ]
}

Recent changes

Generated from contracts/v2/autocomplete/glossary.md in the USAspending API repo.

Loading…