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.0025, 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 7‑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.

1) What is included

Local stdio MCP command: apimail-mcp
Exposed tools: apimail_user_balance, apimail_domain_availability, apimail_purchase_accounts, apimail_purchased_emails
Proxy model: all pricing and purchase logic stays in ApiMail API (no duplicated price logic in MCP layer)

2) Client configuration

Install command alias first (one-time)

cd /root/apimail.me/mcp-apimail
npm install
npm link

After npm link, the global command apimail-mcp becomes available and no local file path is needed in client config.

Cursor MCP config example (hidden path)

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

Windows example (hidden path)

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

3) Rules for adding to a client

Use command alias apimail-mcp so local filesystem paths stay hidden in docs and client config.
If command is missing after updates, re-run npm link in mcp-apimail and reload MCP client.
Do not hardcode prices or business calculations in MCP tools. Always call ApiMail API endpoints.
Keep token in environment variables; do not commit secrets to repository.
For purchases, pass only validated input (count 1..500, known age values).
Treat API errors as final source of truth (BAD_TOKEN, NOT_ENOUGH_STOCK, MAINTENANCE).
Run MCP server locally and restart client after config updates.

4) Test prompts in 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"