API Documentation Builder

Build request URLs visually: pick parameters and see URL and example response update in real time. Classic docs (legacy)

Authentication required

Please sign in to see your API token and use private endpoints.

GET /userBalance

Returns current balance for the authenticated user.

Response format

Generated URL

https://api.apimail.me/userBalance?token=YOUR_API_TOKEN

Example response

GET /getEmail

Returns ready-to-use email accounts. Price depends on age: fresh $0.0029, medium $0.0050, aged $0.0070, old $0.0100. If age is not set, the cheapest available account is returned.

Count 1–500

Domain

Age

Response format

Generated URL

https://api.apimail.me/getEmail?token=YOUR_API_TOKEN

Example response

GET /purchasedEmails

Returns accounts purchased in a specific expense (payment_id) while the 30-day retention period is active.

payment_id

Response format

Generated URL

https://api.apimail.me/purchasedEmails?token=YOUR_API_TOKEN

Example response

GET /domainAvailability

Public statistics about available accounts per domain and age band. No API token is required.

Domain

Age

Response format

Generated URL

https://api.apimail.me/domainAvailability

Example response

GET /emailRisk

Returns a transparent 0–100 risk & reputation score for an email address with a per-signal score_breakdown. Signals: domain DNS/MX, SPF & DMARC policy, disposable & free providers (including hidden alias domains detected by MX), typosquatting / lookalike domains, Spamhaus DBL blacklist, domain age & expiry, suspicious TLDs, role accounts, Gravatar presence, optional SMTP deliverability and a data-breach / leak lookup (leaked, leaks_found, leak_sources — informational, does not affect the score; every API call is billed, so breach data is always included. On the website it is shown only in paid checks). $0.0050 is charged per check from your balance.

Parameters: email (required) — address to check; smtp=1 (optional) — also run a live SMTP deliverability probe (mailbox existence + catch-all; the web tool runs it automatically); type=text (optional) — compact OK|score|level|reputation response.

Generated URL

https://api.apimail.me/emailRisk?token=YOUR_API_TOKEN&email=user@example.com

Example response

{
  "status": "OK",
  "email": "user@example.com",
  "valid": true,
  "risk_score": 13,
  "risk_level": "low",
  "reputation": "good",
  "suspicious": false,
  "reasons": ["spoofable_domain", "free_email_provider"],
  "score_breakdown": {"spoofable_domain": 8, "free_email_provider": 5},
  "details": {
    "domain": "example.com",
    "valid_mx": true,
    "disposable": false,
    "disposable_mx": false,
    "lookalike_of": null,
    "blacklisted": false,
    "free_provider": true,
    "domain_created": "2010-04-23",
    "domain_expires": "2027-04-23",
    "spoofable": true,
    "gravatar": false,
    "leaked": true,
    "leaks_found": 9,
    "leak_sources": [{"name": "Canva.com", "date": "2019-05"}],
    "leak_fields": ["name", "username", "phone"],
    "leak_first": "2019-05",
    "leak_last": "2023-06"
  },
  "charged": "0.0050",
  "balance": "12.3406"
}

Risk levels: 0–20 low / good, 21–50 medium / neutral, 51–100 high / risky. On the website each registered user gets 10 free checks per day (reset at 00:00 UTC); the API has no free tier — every check is billed.

MCP apimail-mcp

Connect ApiMail as an MCP tool server in Cursor or any MCP-compatible client. Use the npm package (same pattern as other MCP servers).

1) Requirements

Node.js 18+ installed (includes npx)
Your ApiMail API token (shown above if signed in)

2) Add to your MCP client

Open your MCP config file and paste the block below. Works on macOS, Linux, and Windows — no local path needed.

{
  "mcpServers": {
    "apimail": {
      "command": "npx",
      "args": ["-y", "apimail-mcp@latest"],
      "env": {
        "APIMAIL_TOKEN": "YOUR_API_TOKEN",
        "APIMAIL_BASE_URL": "https://api.apimail.me"
      }
    }
  }
}

Config file location: Cursor — ~/.cursor/mcp.json, Claude Desktop — claude_desktop_config.json. Restart the client after saving.

3) Available tools

apimail_user_balance — get current account balance
apimail_domain_availability — check available accounts per domain and age
apimail_purchase_accounts — purchase Outlook accounts (count 1–500, optional domain/age filter)
apimail_purchased_emails — fetch purchased accounts by payment_id
apimail_email_risk — check an email address risk & reputation (0–100 score); $0.0050 per check

4) Try it

After connecting, type any of these in your AI client:

"Show my ApiMail balance"
"Check domain availability for outlook.com aged"
"Purchase 2 fresh accounts for outlook.com"
"Get purchased emails for payment_id 12345"
"Check the risk score of john@example.com"