API reference

Authentication

Programmatic requests are authenticated with an API key. Create one from API keys in your dashboard. Two methods are supported:

Authorization: Bearer ofm_live_xxx      # recommended
?api-key=ofm_live_xxx                    # backwards compatible

Base URL

Returns a random active disposable email address and reserves $0.002 (hold) from your balance.

curl "https://oneformail.com/get_mail?api-key=$KEY&domain=mail&from=twitch.tv"

# 200
{ "mail": "abc@mail.com", "domain": "mail.com", "from": "twitch.tv",
  "balance": 9.998, "currency": "USD", "charged": 0.002 }

Scans the inbox for the given email address for ~80s; if a matching message arrives, returns its contents and captures the charge.

curl "https://oneformail.com/get_otp?api-key=$KEY&mail=abc@mail.com"

# 200 (code found)
{ "mail": "abc@mail.com", "subject": "522322 - Your code",
  "sender": "Twitch <no-reply@twitch.tv>", "pending": false }

Releases the reservation when no mail arrives; the hold is refunded. (Backwards compatible: /cancel.)

curl "https://oneformail.com/release?api-key=$KEY&mail=abc@mail.com"

# 200
{ "released": true, "refunded": true, "balance": 10.000 }

Returns your current balance and the per-OTP unit price.

curl "https://oneformail.com/balance?api-key=$KEY"

# 200
{ "balance": 9.998, "currency": "USD", "mail_cost": 0.002 }