Client API Reference

REST API for the Proxied network. Clients browse the marketplace catalog of listings, the locations and device carriers it can be filtered by and the capabilities its devices can offer, read their wallet balance and buy listings from it, read, label and toggle auto-renew on the subscriptions they hold, and manage the additional credentials on a live subscription.

Base URL

OpenAPI Specification

The whole API as one OpenAPI 3.0.3 document. Import it into Postman or Insomnia, or generate a client from it.

Response Envelope

All API responses use a consistent envelope structure:

{
  "success": true,
  "data": { ... },
  "dictionaries": { ... }
}

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "..."
  }
}

Responses that carry codes, such as country, city, capability and limit codes, also include a top-level dictionaries object that describes each code once, with a text per language.