Developers API

Rent a temporary email address for 10 minutes and read the emails a site sends to it, straight from your code. One API key, plain HTTPS and JSON.

Quickstart: one order, end to end

  1. Pick a domain: GET /api/v1/site-domain-yield shows which domains receive email from your site right now (advice only); GET /api/v1/domains lists the domains on sale.
  2. Place the order with POST /api/v1/orders and a NEW `idempotency-key`. If the request gets no response, retry with the SAME key.
  3. Poll GET /api/v1/orders/{id}/messages every 5-10 seconds until an email arrives or `leaseExpiresAt` passes.
  4. Read the newest message: the LAST item of `messages`. Never rely on `refundAmount`.
  5. Done early? Once an email has arrived, POST /api/v1/orders/{id}/complete closes the order and frees its open-order slot within seconds. Otherwise it closes by itself after its 10 minutes.

Conventions

All paths start with `/api/v1`.

JSON · USD, can be below one cent (`0.001`) · ISO 8601 UTC · UUID order ids

Pricing