Getting started
From nothing to the first JSON in five minutes. An immit account, a key, a curl, an entry.
Make an account and a key
Sign in to immit, open the console and create a key. Name it after the thing that will hold it. The secret is shown once; the console keeps only its first twelve characters, so copy it into your secret store before you close the dialog.
Call
/v1/meEvery request carries the key as a bearer token. The first call proves the key and shows you the account's balance and the rates.
200 · application/json- x-ratelimit-limit: 300
- x-ratelimit-remaining: 299
- x-ratelimit-reset: 49
- x-balance-remaining: 2
Look a word up
The headword is UTF-8, percent-encoded. A headword that differs only in case, another spelling of the same word or an inflected form (食べた, went) resolves to the entry, and the canonical headword comes back in the response.
200 · abridgedSearch
A query matches a headword prefix, an inflected surface form and, for Japanese, a reading, so 食べました finds 食べる and たべ finds it too. A Japanese reading may be typed in romaji: taberu finds 食べる. The order is immit's own ranking, the same the apps use.
200 · abridgedRead the headers
Every response carries where you stand: the burst a minute, and the dollars left in the account's balance. Each entry an answer carries draws one word from it, so a search costs what it returns. Over the burst is a 429 with
retry-after, an empty balance is a 402, and a refused request is not counted. Rate limits and the balance has the table.