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

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

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"