List Geolocations

client.Radar.Geolocations.List(ctx, query) (*GeolocationListResponse, error)

GET/radar/geolocations

Retrieves a list of geolocations. Geolocation names can be localized by sending an Accept-Language HTTP header with a BCP 47 language tag (e.g., Accept-Language: pt-PT). The full quality-value chain is supported (e.g., pt-PT,pt;q=0.9,en;q=0.8).

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

User Details WriteUser Details Read

ParametersExpand Collapse

query GeolocationListParams

Format param.Field[GeolocationListParamsFormat]optional

Format in which results will be returned.

const GeolocationListParamsFormatJson GeolocationListParamsFormat = "JSON"

const GeolocationListParamsFormatCsv GeolocationListParamsFormat = "CSV"

GeoID param.Field[string]optional

Filters results by geolocation. Specify a comma-separated list of GeoNames IDs.

Limit param.Field[int64]optional

Limits the number of objects returned in the response.

exclusiveMinimum

minimum0

Location param.Field[string]optional

Filters results by location. Specify a comma-separated list of alpha-2 location codes.

Offset param.Field[int64]optional

Skips the specified number of objects before fetching the results.

minimum0

ReturnsExpand Collapse

type GeolocationListResponse struct{…}

Geolocations []GeolocationListResponseGeolocation

GeoID string

Latitude string

A numeric string.

Longitude string

A numeric string.

Name string

Parent GeolocationListResponseGeolocationsParent

GeoID string

Latitude string

A numeric string.

Longitude string

A numeric string.

Name string

Parent GeolocationListResponseGeolocationsParentParent

GeoID string

Latitude string

A numeric string.

Longitude string

A numeric string.

Name string

Type GeolocationListResponseGeolocationsParentParentType

The type of the geolocation.

One of the following:

const GeolocationListResponseGeolocationsParentParentTypeContinent GeolocationListResponseGeolocationsParentParentType = "CONTINENT"

const GeolocationListResponseGeolocationsParentParentTypeCountry GeolocationListResponseGeolocationsParentParentType = "COUNTRY"

const GeolocationListResponseGeolocationsParentParentTypeAdm1 GeolocationListResponseGeolocationsParentParentType = "ADM1"

Code stringoptional

Locale stringoptional

BCP 47 locale code used for the geolocation name translation

Type GeolocationListResponseGeolocationsParentType

The type of the geolocation.

One of the following:

const GeolocationListResponseGeolocationsParentTypeContinent GeolocationListResponseGeolocationsParentType = "CONTINENT"

const GeolocationListResponseGeolocationsParentTypeCountry GeolocationListResponseGeolocationsParentType = "COUNTRY"

const GeolocationListResponseGeolocationsParentTypeAdm1 GeolocationListResponseGeolocationsParentType = "ADM1"

Code stringoptional

Locale stringoptional

BCP 47 locale code used for the geolocation name translation

Type GeolocationListResponseGeolocationsType

The type of the geolocation.

One of the following:

const GeolocationListResponseGeolocationsTypeContinent GeolocationListResponseGeolocationsType = "CONTINENT"

const GeolocationListResponseGeolocationsTypeCountry GeolocationListResponseGeolocationsType = "COUNTRY"

const GeolocationListResponseGeolocationsTypeAdm1 GeolocationListResponseGeolocationsType = "ADM1"

Code stringoptional

Locale stringoptional

BCP 47 locale code used for the geolocation name translation

List Geolocations

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
  "github.com/cloudflare/cloudflare-go/radar"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  geolocations, err := client.Radar.Geolocations.List(context.TODO(), radar.GeolocationListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", geolocations.Geolocations)
}

{
  "result": {
    "geolocations": [
      {
        "geoId": "2267056",
        "latitude": "10",
        "longitude": "10",
        "name": "Lisbon",
        "parent": {
          "geoId": "2267056",
          "latitude": "10",
          "longitude": "10",
          "name": "Lisbon",
          "parent": {
            "geoId": "2267056",
            "latitude": "10",
            "longitude": "10",
            "name": "Lisbon",
            "type": "CONTINENT",
            "code": "PT-11",
            "locale": "pt-PT"
          },
          "type": "CONTINENT",
          "code": "PT-11",
          "locale": "pt-PT"
        },
        "type": "CONTINENT",
        "code": "PT-11",
        "locale": "pt-PT"
      }
    ]
  },
  "success": true
}

Returns Examples

{
  "result": {
    "geolocations": [
      {
        "geoId": "2267056",
        "latitude": "10",
        "longitude": "10",
        "name": "Lisbon",
        "parent": {
          "geoId": "2267056",
          "latitude": "10",
          "longitude": "10",
          "name": "Lisbon",
          "parent": {
            "geoId": "2267056",
            "latitude": "10",
            "longitude": "10",
            "name": "Lisbon",
            "type": "CONTINENT",
            "code": "PT-11",
            "locale": "pt-PT"
          },
          "type": "CONTINENT",
          "code": "PT-11",
          "locale": "pt-PT"
        },
        "type": "CONTINENT",
        "code": "PT-11",
        "locale": "pt-PT"
      }
    ]
  },
  "success": true
}