Get location details

client.Radar.Entities.Locations.Get(ctx, location, query) (*EntityLocationGetResponse, error)

GET/radar/entities/locations/{location}

Retrieves the requested location information. (A confidence level below 5 indicates a low level of confidence in the traffic data - normally this happens because Cloudflare has a small amount of traffic from/to this location).

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

location string

Location alpha-2 code.

maxLength2

minLength2

query EntityLocationGetParams

Format param.Field[EntityLocationGetParamsFormat]Optional

Format in which results will be returned.

const EntityLocationGetParamsFormatJson EntityLocationGetParamsFormat = "JSON"

const EntityLocationGetParamsFormatCsv EntityLocationGetParamsFormat = "CSV"

ReturnsExpand Collapse

type EntityLocationGetResponse struct{…}

Location EntityLocationGetResponseLocation

Alpha2 string

ConfidenceLevel int64

Continent string

Latitude string

A numeric string.

Longitude string

A numeric string.

Name string

Region string

Subregion string

Get location details

package main

import (
  "context"
  "fmt"

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

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  location, err := client.Radar.Entities.Locations.Get(
    context.TODO(),
    "US",
    radar.EntityLocationGetParams{

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

{
  "result": {
    "location": {
      "alpha2": "AF",
      "confidenceLevel": 5,
      "continent": "AS",
      "latitude": "10",
      "longitude": "10",
      "name": "Afghanistan",
      "region": "Middle East",
      "subregion": "Southern Asia"
    }
  },
  "success": true
}

Returns Examples

{
  "result": {
    "location": {
      "alpha2": "AF",
      "confidenceLevel": 5,
      "continent": "AS",
      "latitude": "10",
      "longitude": "10",
      "name": "Afghanistan",
      "region": "Middle East",
      "subregion": "Southern Asia"
    }
  },
  "success": true
}