opencage-api-client
    Preparing search index...

    Type Alias GeocodingRequest

    GeocodingRequest: OptionalParameters & {
        key?: string;
        proxyURL?: string;
        q: string;
    }

    GeocodingRequest and related request parameters for the OpenCage API.

    Type Declaration

    • Optionalkey?: string

      a 30 character long, alphanumeric string. The API Key is required when used in a browser. In a Node environment, it is optional, as it will be added automatically from the environment variable OPENAI_API_KEY, and a .env file can also be used.

    • OptionalproxyURL?: string

      Use GeocodingOptions.proxyURL instead. The URL of a proxy server to use for the request. This is useful if you want to hide your API Key.

    • q: string

      the query string to be geocoded: a latitude, longitude or a place name/address.