Geocode a place name

GET
https://api.cirrosense.com/geocode

Returns a list of locations matching the given place name

Query Parameters

  • key

    string
    required

    Your Cirrosense API key

  • place

    string
    required

    Place name to search for

    Min length: 1Max length: 50

  • limit

    integer

    Maximum number of results to return

    Min: 1Max: 25

    Default: 5

Response Codes

Status Description Schema
200 Success Geocode Response
400 Invalid Request ErrorResponse
429 Rate Limit Exceeded ErrorResponse

Example Request

GET /geocode 
curl -G https://api.cirrosense.com/geocode \
  -d "key=YOUR_CIRROSENSE_API_KEY" \
  -d "place=New York" \
  -d "limit=5"
Response
{
  "results": [
    {
      "lat": 40.7128,
      "lon": -74.006,
      "name": "New York",
      "admin": "New York",
      "country": "United States",
      "iso2": "US",
      "timezone": "America/New_York"
    },
    ...
  ]
}