Developer Portal/API Reference

API Reference

Interactive reference for the Citrus Mobile Reseller API — try any endpoint directly from this page.

Markdown for AI agentsGuides & Recipes
New

Citrus Mobile MCP server is live

Connect Claude Code, Cursor, or any MCP client straight to the API.

No key needed

  • Per-country data rates
  • Coverage and network lookups
  • Cost estimates for any order size
  • API docs search

With your API key

  • Provision eSIMs from your agent
  • Fund eSIM wallets
  • List and inspect your eSIMs
  • Account balance and status

Public tools, no key needed

claude mcp add --transport http citrus https://citrusmobile.com/api/mcp

Account tools, with your API key

claude mcp add --transport http citrus https://citrusmobile.com/api/mcp \
  --header "Authorization: Bearer rsk_YOUR_KEY"

Replace rsk_YOUR_KEY with your actual API key. It starts with rsk_ and you can create one in the developer dashboard.

Other clients: point them at https://citrusmobile.com/api/mcp (streamable HTTP) and send the same Authorization header.

Citrus Mobile Reseller API v2.0

Build your own eSIM platform with pay-as-you-go connectivity in 200+ countries.

Base URL https://citrusmobile.com/api/v2/reseller. Authenticate with a Bearer API key (rsk_ prefix). Full reference: Markdown · OpenAPI YAML.

  • POST/esim/provision — Provision a new eSIM
  • GET/esim/list — List your eSIMs
  • GET/esim/{iccid} — Get eSIM details
  • POST/esim/{iccid}/enable — Enable data on an eSIM
  • POST/esim/{iccid}/disable — Disable data on an eSIM
  • POST/esim/{iccid}/terminate — Terminate an eSIM
  • POST/esim/{iccid}/throttle — Throttle SIM speed
  • POST/esim/{iccid}/defund — Return an eSIM's unused balance
  • POST/esim/{iccid}/fund — Fund an eSIM wallet
  • GET/groups — List groups (New)
  • POST/groups — Create a group (New)
  • GET/groups/{id} — Get a group (New)
  • PATCH/groups/{id} — Update a group (New)
  • POST/groups/{id}/fund — Move funds into a group (New)
  • POST/groups/{id}/defund — Return a group balance to your account (New)
  • GET/groups/{id}/esims — List eSIMs in a group (New)
  • POST/groups/{id}/esims — Add an eSIM to a group (New)
  • DELETE/groups/{id}/esims/{iccid} — Remove an eSIM from a group (New)
  • GET/wallet/balance — Get reseller account balance
  • GET/rates — Get per-country data rates
  • GET/account — Get account details
  • GET/webhooks — List webhook endpoints
  • POST/webhooks — Register a new webhook endpoint
  • GET/webhooks/{id} — Get webhook detail
  • PUT/webhooks/{id} — Update a webhook
  • DELETE/webhooks/{id} — Delete a webhook
  • POST/webhooks/{id}/test — Send a test event
Loading interactive reference…