Skip to content

Get Sub Geograhies

This function will return a JSON array of Sub Geography divisions for a country. Note that since this is intended to support the ePremise data, only a few countries are supported.

Supported Countries

  • AU
  • BR
  • CA
  • US

Path

1
https://epremise-api.b-fonline.com/subgeo/{iso_code}

Method

1
GET

Required Parameters

  • iso_code (ISO2 or ISO3 country code)

Responses

200 - JSON array of sub geography objects

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
[
  {...},
  {
    "subgeo_type": "State",
    "country_iso2": "AU",
    "country_iso3": "AUS",
    "subgeo_abbrv": "NSW",
    "subgeo_name": "New South Wales"
  },
  {
    "subgeo_type": "State",
    "country_iso2": "AU",
    "country_iso3": "AUS",
    "subgeo_abbrv": "QLD",
    "subgeo_name": "Queensland"
  },
  {...},
]

Code Examples

1
2
3
curl -X GET \
https://epremise-api.b-fonline.com/subgeo/AU \
-H 'cache-control: no-cache'