API
A small JSON API. Create an inbox, read mail, get verification codes back as fields, and stream new messages as they arrive. No account needed.
Base URL
Live streamServer-sent events deliver mail the moment it arrives.
Codes extractedOne-time codes and verify links are returned as fields.
No sign-upWorks anonymously. Add a key for higher limits.
Quickstart
Get a code from a sign-up email in three calls.
Authentication
Most endpoints are open: an inbox is identified by its address, and anyone who knows the address can read it. To raise your rate limit, send an API key in the X-API-Key header. Keys are issued by the site operator.
Tip. Paste a key into the box at the top right and every "Try it" request on this page will include it.
Rate limits
| Caller | Sustained | Burst |
|---|---|---|
| Anonymous (per IP) | 2 requests / sec | 20 |
| With API key | 20 requests / sec | 100 |
Exceeding a limit returns 429 with a Retry-After header. The live stream endpoint is not limited, so prefer it over polling.
Errors
Errors return a JSON body such as {"error":"invalid address"} with a matching status.
| Status | Meaning |
|---|---|
400 | Invalid input: bad address, unknown domain, reserved or malformed name. |
401 | The X-API-Key you sent is not valid. |
403 | The address is blocked by the operator. |
404 | Message or domain not found. |
429 | Rate limit exceeded. Wait for Retry-After seconds. |
Full example
Create an inbox, then wait for a verification code over the live stream.