Resolve

Resolve an organization name to an EIN and canonical URL

Entity resolution — the step that precedes every other call when you have a name rather than an EIN. Searches every US grantmaking foundation and funded nonprofit, or the Canadian charities register under jurisdiction=ca. No API key required and not metered.

q also accepts an EIN (131684331 or 13-1684331), which resolves against the index directly rather than as text. A parameter this endpoint does not accept comes back named in x_plinth.warnings, and strict=1 turns that into a 400 — the same contract as the grant endpoints. Omitting q is a 400 rather than an empty result set, because an empty result set is indistinguishable from a genuine miss.

get/api/v1/search

Request

  • Base URL: https://data.useplinth.com
  • URL: https://data.useplinth.com/api/v1/search
  • Auth: none required

Query parameters

qstring required
Example:skillman

Search text. Fewer than 2 characters returns an empty result set.

jurisdiction'us' | 'ca'

Which register to search: us (IRS, the default) or ca (CRA). Case-insensitive. One register per query, because revenue is the filing's own figure and the two currencies are never combined. Any other value is a 400, as is a value that contradicts the namespace of an organization key passed as q.

statestring
Example:MI

Narrow to a two-letter region code — a US state, or a province or territory under jurisdiction=ca. Case-insensitive; anything else is reported in x_plinth.warnings rather than applied as a filter that cannot match.

limitinteger

Rows to return. Capped at 50 — this endpoint resolves names, it does not page the corpus.

mininteger

Lowest total revenue, whole units of the filing's own currency — US dollars, or Canadian dollars under jurisdiction=ca, which is stated back in x_plinth.warnings. Applied server-side, so it cannot drop matches past the cut.

maxinteger

Highest total revenue, in the same currency as min.

strictstring

strict=1 turns any parameter this endpoint does not accept into a 400 instead of a warning.

examplestring
Example:1

Return a canned example response instead of querying the index — keyless, unmetered, and the only way to see this envelope without sending a real q. ?example=1 is the plain case; ?example=list names the others. Every example body carries x_plinth.example.

Response

Matching organizations, best first.

modestring

The matching mode actually served. Always text today: the vector index is unpopulated, so semantic matching is not offered and the mode REQUEST parameter is deliberately not part of this contract. Sending one is not an error — it comes back named in x_plinth.warnings. Present on EVERY response, including errors and the too-short-query case.

Changes

No recorded changes to this operation across all 1 revision of this API.