/grantsgov/opportunities

POST /api/grantsgov/opportunities

Price: 10 credits

Full record of a US federal funding opportunity by its UUID: agency, assistance listing, dates, eligibility, award sizes, the funding and category classifications, the description, and the application documents attached to it.

How to use it

Only the UUID resolves here. A funding opportunity number such as L26AS00045 does not — find its UUID through grantsgov/opportunities/search first. `description` and `close_note` are returned in full, not truncated the way the page shows them. Award figures are what the grantor announced for the whole programme: `program_funding` is the pot, `award_minimum` and `award_maximum` bound a single award, so do not read either as a per-applicant guarantee. A forecasted opportunity is not open yet and has no posted, close or archive date at all — its timing is the grantor's own estimate, in the `estimated_*` fields and `fiscal_year`, and every one of those dates can still move.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• opportunity_id string required — Opportunity UUID as it appears in the simpler.grants.gov opportunity URL (examples: "35158e43-744a-4d27-91cf-b29f61374259"; minLength: 1)

Response

• @type string (default: "GrantsgovOpportunity")
• opportunity_id string required
• opportunity_title string required
• url string required
• agency string nullable
• assistance_listing_number string nullable
• assistance_listing_title string nullable
• funding_opportunity_number string nullable
• legacy_opportunity_id string nullable
• status string nullable
• close_date string nullable
• close_note string nullable
• posted_date string nullable
• archive_date string nullable
• estimated_post_date string nullable
• estimated_application_due_date string nullable
• estimated_due_date_description string nullable
• estimated_award_date string nullable
• estimated_project_start_date string nullable
• fiscal_year integer nullable
• forecast_posted_date string nullable
• last_updated_date string nullable
• version string nullable
• description string nullable
• eligibility_note string nullable
• eligible_applicant_groups array (default: [])
  • @type string (default: "GrantsgovEligibleApplicantGroup")
  • name string required
  • applicants array (default: [])
• grantor_contact string nullable
• grantor_email string nullable
• additional_information_url string nullable
• program_funding number nullable
• expected_award_count integer nullable
• award_minimum number nullable
• award_maximum number nullable
• has_cost_sharing boolean nullable
• funding_instrument_type string nullable
• opportunity_category string nullable
• opportunity_category_explanation string nullable
• funding_activity_category string nullable
• funding_activity_category_explanation string nullable
• documents array (default: [])
  • @type string (default: "GrantsgovOpportunityDocument")
  • name string required
  • url string required
  • description string nullable
  • updated_at_text string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No opportunity exists under that UUID Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.