API Guide







Get Regions

The get region API returns a region along with the supported ISPs within it, or a list of targetable regions to configure your seed list if a region ID is not provided. Data is returned in the following formats: XML, JSON, CSV and Serialized.

Required headers: X-API-KEY
Optional headers: ACCEPT (json, xml, csv, serialized)
Method: GET

Endpoint URL:

https://api.250ok.com/api/1.0/inboxinformant/region

Sample Output (without ID):

[
  {
    "id": 3,
    "name": "Global",
    "audience": "b2c"
  },
  {
    "id": 1,
    "name": "North America",
    "audience": "b2c"
  },
  {
    "id": 2,
    "name": "South America",
    "audience": "b2c"
  },
  {
    "id": 6,
    "name": "Europe",
    "audience": "b2c"
  },
  {
    "id": 7,
    "name": "Africa",
    "audience": "b2c"
  },
  {
    "id": 8,
    "name": "Asia",
    "audience": "b2c"
  },
  {
    "id": 9,
    "name": "Oceania",
    "audience": "b2c"
  },
  {
    "id": 13,
    "name": "Hosting Companies",
    "audience": "b2b"
  },
  {
    "id": 15,
    "name": "Filter Companies",
    "audience": "b2b"
  }
]
                    

Sample Output (with region ID):

{
  "id": 1,
  "name": "North America",
  "audience": "b2c",
  "providers": [
    {
      "id": 15,
      "name": "ATT"
    },
    {
      "id": 17,
      "name": "Bell Canada"
    },
    {
      "id": 21,
      "name": "Cablevision"
    },
    {
      "id": 23,
      "name": "Charter"
    },
    {
      "id": 27,
      "name": "Comcast"
    },
    {
      "id": 28,
      "name": "Cox"
    },
    {
      "id": 29,
      "name": "Earthlink"
    },
    {
      "id": 55,
      "name": "NetZero"
    },
    {
      "id": 66,
      "name": "RCN"
    },
    {
      "id": 68,
      "name": "Roadrunner"
    },
    {
      "id": 69,
      "name": "Rogers"
    },
    {
      "id": 73,
      "name": "Shaw"
    },
    {
      "id": 81,
      "name": "Teksavvy"
    },
    {
      "id": 87,
      "name": "Verizon"
    },
    {
      "id": 88,
      "name": "Videotron"
    },
    {
      "id": 94,
      "name": "Yahoo!"
    }
  ]
}
                

Parameters

Parameter Description Acceptable Values Required
id The unique identifier of the region Integer N

Error Responses

Description Code Cause
Invalid region ID 404 The unique identifier of the region is invalid