action ideal_postcodes_find_place {
  label: "Find Place"
  description: "Query for geographical places across countries. Each query will return a list of place suggestions, which consists of a place name, descriptive name and id.\n\nThis API returns geographical information such as countries, capitals, administrative areas and more. It is ideal for correctly identifying a place along with any other details like geolocation.\n\n## Implementing Place Autocomplete\n\nExtracting the full information of a place is a 2 step process:\n\n1. Retrieve place suggestions via /places\n2. Retrieve the entire place with the ID provided in the suggestion\n\n## Suggestion Format\n\nEach place suggestion contains a descriptive name which you can provide to users to uniquely idenfity a place.\n\n## Rate Limiting\n\nYou can make up to 3000 requests to the autocomplete API within a 5 minute span. The HTTP Header contains information on your current rate limit.\n\n| Header                  | Description                                                                            |\n| ----------------------- | -------------------------------------------------------------------------------------- |\n| `X-RateLimit-Limit`     | The maximum number of requests that can be made in 5 minutes                           |\n| `X-RateLimit-Remaining` | The remaining requests within the current rate limit window                            |\n| `X-RateLimit-Reset`     | The time when the rate limit window resets in Unix Time (seconds) or UTC Epoch seconds |\n\n## Pricing\n\nThis API currently does not affect your balance. However, resolving a suggestion into a full place requires a paid request.\n\nPlease note, this API is not intended as a standalone free resource. Integrations that consistently make autocomplete requests without a paid request to resolve an place may be disrupted via tightened rate limits.\n"
  provider: ideal_postcodes
  method: GET
  path: "/places"
  encoding: json
  input: {
    type: "object"
    properties: {
      api_key: {
        type: "string"
        description: "Your API Key. Typically beings `ak_`.\n\nAvailable from your dashboard\n"
      }
      bias_country_iso: {
        type: "string"
        description: "Bias by country ISO code. Uses 3 letter country code (ISO 3166-1) standard.\nBias by multiple countries with a comma separated list. E.g. `GBR,IRL`"
      }
      bias_ip: {
        type: "string"
        description: "Biases search based on approximate geolocation of IP address.\nSet `bias_ip=true` to enable."
        enum: ["true"]
      }
      bias_lonlat: {
        type: "string"
        description: "Bias search to a geospatial circle determined by an origin and radius in meters. Max radius is `50000`.  Uses the format bias_lonlat=[longitude],[latitude],[radius in metres] Only one geospatial bias may be provided"
      }
      country_iso: {
        type: "string"
        description: "Filter by country ISO code. Uses 3 letter country code (ISO 3166-1) standard.\nFilter by multiple countries with a comma separated list. E.g. `GBR,IRL`"
      }
      query: {
        type: "string"
      }
    }
    required: ["api_key"]
    additionalProperties: false
  }
  output: {
    type: "object"
    required: ["code", "message", "result"]
    properties: {
      code: {
        type: "integer"
        format: "int32"
        enum: [2000]
      }
      message: {
        type: "string"
        enum: ["Success"]
      }
      result: {
        type: "object"
        required: ["hits"]
        properties: {
          hits: {
            type: "array"
            description: "List of up to 10 matching places\n"
            items: {
              type: "object"
            }
          }
        }
      }
    }
  }
}