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. Use the npm package (same pattern as other MCP servers): no local project path in config.

1) What is included

Npm package: apimail-mcp (run via npx)
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) One-time publish (project maintainers)

For npx apimail-mcp@latest to work on every machine, the package must exist on the npm registry. Publish once from the mcp-apimail folder: npm login, then npm publish.

3) Client configuration (recommended)

Cursor / Claude Desktop (no local path)

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

Same on Windows — use the same JSON; npx is provided with Node.js.

4) Rules for adding to a client

Prefer npx -y apimail-mcp@latest so configs never contain a local filesystem path.
Do not commit real API tokens; use env only in the 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).
Restart the MCP client after changing env or package version.

5) 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"