{
  "opencollection": "1.0.0",
  "info": {
    "name": "CycleCalcs Astronomy Places API",
    "version": "2.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Places",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Place-name search and reverse lookup against the self-hosted GeoNames index, returning name, region, country, coordinates and IANA timezone with a stable place_id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://www.cyclecalcs.com/v2/places",
            "params": [
              {
                "name": "q",
                "value": "cambridge",
                "type": "query",
                "description": "A place name to search for, at least 2 characters after trimming. Mutually exclusive with `id` and with `lat`/`lon`."
              },
              {
                "name": "id",
                "value": "gb-n52125-w000008",
                "type": "query",
                "description": "An exact place_id from a previous /v2/places response, for example us-n35198-w111651. Mutually exclusive with `q` and with `lat`/`lon`."
              },
              {
                "name": "lat",
                "value": "51.4778",
                "type": "query",
                "description": "Latitude in decimal degrees, north positive. No compass suffix (do not append N or S). Required together with lon, or neither."
              },
              {
                "name": "lon",
                "value": "-0.0015",
                "type": "query",
                "description": "Longitude in decimal degrees, east positive. No compass suffix (do not append E or W). Required together with lat, or neither."
              },
              {
                "name": "country",
                "value": "GB",
                "type": "query",
                "description": "Restricts a name search to one country: an ISO 3166-1 alpha-2 code (case-insensitive) or a country name."
              },
              {
                "name": "region",
                "value": "Cambridgeshire",
                "type": "query",
                "description": "Restricts a name search to one admin region (state or province name) as stored in the index."
              },
              {
                "name": "limit",
                "value": "5",
                "type": "query",
                "description": "Maximum number of place matches to return, 1 to 25."
              },
              {
                "name": "min_population",
                "value": "100000",
                "type": "query",
                "description": "Only return places at or above this population. The index stores population to the nearest 1,000, so the value is rounded up to the next thousand."
              },
              {
                "name": "radius_km",
                "value": "25",
                "type": "query",
                "description": "Search radius in kilometres for a reverse (lat/lon) lookup. Default 250."
              },
              {
                "name": "format",
                "value": "json",
                "type": "query",
                "description": "Response representation. Each endpoint serves a subset of json, csv and txt; see that operation's description for the exact list, or GET /v2 for every endpoint's formats array. An unsupported value is 400 BAD_FORMAT with the accepted list in `supported`."
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Comma-separated dot paths into `data` (for example moon.phase_name,moon.illumination) so only those fields are returned. Up to 64 paths; an array element is addressed by its object key, never by index."
              },
              {
                "name": "shape",
                "value": "nested",
                "type": "query",
                "description": "nested returns the documented object tree. flat returns one object with dotted keys, format=json only."
              },
              {
                "name": "precision",
                "value": "6",
                "type": "query",
                "description": "Decimal places for numeric fields."
              },
              {
                "name": "pretty",
                "value": "1",
                "type": "query",
                "description": "Whether the JSON body is indented (1) or compact (0). Has no effect on csv or txt."
              },
              {
                "name": "verbosity",
                "value": "full",
                "type": "query",
                "description": "full includes prose notes, frame definitions and withheld-field reasons in meta. compact keeps every value and every machine-readable name and drops the prose."
              },
              {
                "name": "time_format",
                "value": "iso",
                "type": "query",
                "description": "How instants are rendered: iso for ISO 8601 strings carrying the effective offset, or unix for integer seconds since the epoch."
              }
            ]
          },
          "docs": "Place-name search and reverse lookup against the self-hosted GeoNames index, returning name, region, country, coordinates and IANA timezone with a stable place_id. Formats: json, csv. Every response is GeoNames data under CC BY 4.0, so every response carries rights: attribution_required and the credit in meta.attribution.text. The rest of the API is unrestricted. Example: GET /v2/places?q=cambridge&limit=5"
        }
      ]
    }
  ],
  "bundled": true
}