/propublica_nonprofit/filings/search

POST /api/propublica_nonprofit/filings/search

Price: 5 credits

Full-text search over the content of US nonprofit Form 990 filings and their schedules. Returns one result per matching form or schedule, with the organization, the fiscal year and a snippet of the matched text.

How to use it

This is the endpoint that reaches inside the filings — grant narratives, schedule tables, programme descriptions, grantee names — so use it for wording that would never appear in an organization's registered name. One result is one form or schedule, so a single organization can match many times; `highlight` shows the matched passage and `highlight_terms` the words that matched. `forms` takes the IRS schedule names the source uses, such as IRS990PF or IRS990ScheduleI, and the set on offer depends on the query, so pass a value only if a previous result carried it in `form_code`.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string required — Words matched against the text of the filed forms and their schedules (examples: "climate", "opioid settlement"; minLength: 1)
• forms array — IRS form and schedule names the match must come from, as they appear in `form_code` (default: []; examples: ["IRS990PF"], ["IRS990ScheduleI","IRS990ScheduleF"])
• years array — Fiscal years of the filing (default: []; examples: [2023,2022])
• states array — Two-letter US state or territory codes of the organization's address (default: []; examples: ["CO","NY"])
• sort string — Order of the results (default: "best"; one of: "best", "name", "-name", "year", "-year")
• count integer required — Max number of filing documents to return (min: 1; max: 4000)

Response

• @type string (default: "PropublicaNonprofitFilingDocument")
• document_title string required
• url string required
• organization_name string nullable
• organization_ein string nullable
• organization_url string nullable
• form_name string nullable
• form_code string nullable
• object_id string nullable
• fiscal_year integer nullable
• city string nullable
• state string nullable
• highlight string nullable
• highlight_terms array (default: [])

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 — The entity was not found, or a precondition failed 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.