Discovery

Find the right calculator, guide or dataset

Search every Calculate.co.nz calculator, guide and dataset by topic.

Start here when there is no dedicated endpoint for what you need, which is almost always: six calculators have their own endpoint and the site has 2,377. Ask in plain language, the way someone would say it out loud, rather than in keywords. "how much tax do I pay on my salary" works better than "tax", because the ranking reads the whole phrase.

NZ-specific pages outrank generic ones on the same topic. Filter with types when you only want, say, guides. score is comparable within one response, not between different queries.

The index is fetched from the website and cached, so the first call after a restart is slower. GET /v1/index-status shows whether it is loaded.

post/v1/find-calculator

Request

  • Base URL: https://api.calculate.co.nz
  • URL: https://api.calculate.co.nz/v1/find-calculator
  • Auth: API key in header X-API-Key

Request body

querystring required

What to work out, in plain language.

limitinteger

Number of results, 1 to 20.

typesstring[] nullable

Restrict to these page types. Omit for all types.

Example request

{
  "limit": 5,
  "query": "how much tax do I pay on my salary"
}

Response

Best matches, highest score first.

querystring nullable

The query as searched.

countinteger

Number of results returned, at most limit.

sourcestring nullable

Where the page index was loaded from.

index_pagesinteger nullable

Pages in the index at the time of the search.

errorstring nullable

Set only when the index could not be loaded. Results will be empty.

Changes

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