Skip to main content
GET
/
connect
/
countries
JavaScript
import Mobilerun from '@mobilerun/sdk';

const client = new Mobilerun({
  apiKey: process.env['MOBILERUN_CLOUD_API_KEY'], // This is the default and can be omitted
});

const countries = await client.connect.countries.list();

console.log(countries.items);
{
  "items": [
    {
      "code": "us",
      "name": "United States",
      "proxyTypes": [
        "dedicated_residential"
      ]
    }
  ],
  "pagination": {
    "hasNext": true,
    "hasPrev": true,
    "page": 123,
    "pageSize": 123,
    "pages": 123,
    "total": 123
  }
}

Authorizations

Authorization
string
header
required

Bearer token via Authorization header

Query Parameters

page
integer
default:1

Page number (1-based).

Required range: x >= 1
pageSize
integer
default:20

Number of items per page.

Required range: 1 <= x <= 100
type
enum<string>
default:dedicated_residential

Filter to countries offering this proxy type.

Available options:
dedicated_residential,
residential,
mobile

Response

200 - application/json

Available countries.

A page of countries.

items
object[]
required
pagination
object
required

Pagination metadata for a list response.