> ## Documentation Index
> Fetch the complete documentation index at: https://docs.closient.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Approximate caller location

> Returns the caller's approximate location, derived server-side from the edge network's view of the connection (Cloudflare `CF-*` visitor-location headers). Intended as the brand locator's fallback when the browser's `navigator.geolocation` permission is denied or times out, so the widget never has to hand the visitor's IP to a third-party geolocation service. City-level accuracy at best. All fields are `null` when the edge did not supply a location — callers must handle that and fall back to asking the visitor for an address. No IP address is stored or returned. **Public, unauthenticated**, rate limited by IP. The response is `private, no-store`: it is derived from the caller's own connection, so a shared cache in front of it would serve one visitor's city to the next.



## OpenAPI

````yaml /openapi/openapi-brands.json get /brands/api/v1/public/geo
openapi: 3.1.0
info:
  title: Brands API
  version: 1.0.0
  description: >
    Brand management: list, create, update, and manage brand profiles.


    ## Authentication


    All endpoints require an API key passed via the `X-API-Key` HTTP header,
    unless otherwise noted.


    ```

    X-API-Key: csb_<body>_<checksum>

    ```


    Generate API keys in **Settings > API Keys** in your dashboard, or via the
    Account API.

    Session-based (cookie) authentication is also accepted for browser-based
    access.


    ## Rate Limits


    | Tier        | Requests / minute | Requests / day |

    |-------------|-------------------|----------------|

    | Default     | 300               | 10,000         |

    | Custom      | Contact us        | Contact us     |


    Rate-limit headers are included on every response so callers can
    self-throttle without

    hitting our 429s ("informed governor"):


    - `RateLimit-Policy` — every active window, e.g. `300;w=60, 10000;w=86400`

    - `RateLimit-Limit` — quota for the **most-restrictive** currently-active
    window

    - `RateLimit-Remaining` — requests left in that window

    - `RateLimit-Reset` — seconds until that window resets (relative; clock-skew
    safe)


    Legacy `X-RateLimit-*` aliases are also emitted for back-compat.
    `X-RateLimit-Reset`

    keeps the absolute Unix-timestamp shape to avoid breaking existing
    consumers.


    When rate-limited, you receive `429 Too Many Requests` with a
    `retry_after_seconds` field

    in the error envelope and a `Retry-After` header.


    ## Pagination


    List endpoints return paginated results in this envelope:


    ```json

    {
      "data": [...],
      "pagination": {
        "page": 1,
        "page_size": 25,
        "total_count": 342,
        "total_pages": 14,
        "has_next": true,
        "has_previous": false
      }
    }

    ```


    Use `?page=2&page_size=50` query parameters. Maximum page size is 100.


    ## Error Responses


    All errors conform to [RFC 9457 Problem
    Details](https://www.rfc-editor.org/rfc/rfc9457)

    with `Content-Type: application/problem+json`:


    ```json

    {
      "type": "https://closient.com/docs/errors/not_found",
      "title": "Not Found",
      "status": 404,
      "detail": "The requested resource was not found.",
      "error_code": "not_found",
      "retryable": false,
      "timestamp": "2026-03-31T12:00:00+00:00"
    }

    ```


    Common error codes: `unauthorized` (401), `forbidden` (403), `not_found`
    (404),

    `validation_error` (422), `rate_limited` (429), `internal_error` (500).
  termsOfService: https://www.closient.com/terms/
servers:
  - url: https://www.closient.com
security: []
tags:
  - name: Brands
    description: Brand CRUD operations.
  - name: Brand Locator (Public)
    description: >-
      Unauthenticated endpoints that power the embeddable brand product-locator
      widget (C-1803). Mounted under the `/public/` prefix so the widget CORS
      middleware opens CORS for them.
externalDocs:
  description: Closient Documentation
  url: https://docs.closient.com
paths:
  /brands/api/v1/public/geo:
    get:
      tags:
        - Brand Locator (Public)
      summary: Approximate caller location
      description: >-
        Returns the caller's approximate location, derived server-side from the
        edge network's view of the connection (Cloudflare `CF-*`
        visitor-location headers). Intended as the brand locator's fallback when
        the browser's `navigator.geolocation` permission is denied or times out,
        so the widget never has to hand the visitor's IP to a third-party
        geolocation service. City-level accuracy at best. All fields are `null`
        when the edge did not supply a location — callers must handle that and
        fall back to asking the visitor for an address. No IP address is stored
        or returned. **Public, unauthenticated**, rate limited by IP. The
        response is `private, no-store`: it is derived from the caller's own
        connection, so a shared cache in front of it would serve one visitor's
        city to the next.
      operationId: apps_brands_api_public_get_brand_locator_coarse_geo
      parameters: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoarseGeoOut'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '404':
          description: Not Found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '405':
          description: Method Not Allowed
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '429':
          description: Too Many Requests
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
components:
  schemas:
    CoarseGeoOut:
      examples:
        - city: Vancouver
          country: CA
          lat: 49.2827
          lon: -123.1207
          region: BC
      properties:
        lat:
          anyOf:
            - maximum: 90
              minimum: -90
              type: number
            - type: 'null'
          description: >-
            Approximate latitude of the caller in decimal degrees, WGS 84 /
            EPSG:4326, or `null` when unknown.
          title: Lat
        lon:
          anyOf:
            - maximum: 180
              minimum: -180
              type: number
            - type: 'null'
          description: >-
            Approximate longitude of the caller in decimal degrees, WGS 84 /
            EPSG:4326, or `null` when unknown.
          title: Lon
        city:
          anyOf:
            - type: string
            - type: 'null'
          description: City name of the caller's network location, or `null` when unknown.
          title: City
        region:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            ISO 3166-2 region code (e.g. `BC`) of the caller's network location,
            or `null`.
          title: Region
        country:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            ISO 3166-1 alpha-2 country code (e.g. `CA`) of the caller's network
            location, or `null`.
          title: Country
      title: CoarseGeoOut
      type: object
    ErrorOut:
      description: |-
        RFC 9457 Problem Details response.

        All API errors are returned in this format with Content-Type:
        application/problem+json.
      examples:
        - detail: The requested resource was not found.
          error_code: not_found
          retryable: false
          status: 404
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Not Found
          type: https://closient.com/docs/errors/not_found
        - detail: Validation error.
          details:
            - loc:
                - body
                - name
              msg: Field required
              type: missing
          error_code: validation_error
          retryable: false
          status: 422
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Validation Error
          type: https://closient.com/docs/errors/validation_error
        - detail: Rate limit exceeded. Please try again later.
          error_code: rate_limited
          retry_after: 31
          retryable: true
          status: 429
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Rate Limited
          type: https://closient.com/docs/errors/rate_limited
      properties:
        type:
          description: URI reference identifying the error type.
          title: Type
          type: string
        title:
          description: Short human-readable summary of the error.
          title: Title
          type: string
        status:
          description: HTTP status code.
          title: Status
          type: integer
        detail:
          description: Human-readable explanation of this specific occurrence.
          title: Detail
          type: string
        error_code:
          description: Machine-readable error code (e.g. not_found, unauthorized).
          title: Error Code
          type: string
        retryable:
          default: false
          description: Whether retrying the same request can succeed.
          title: Retryable
          type: boolean
        timestamp:
          description: ISO 8601 timestamp of when the error occurred.
          title: Timestamp
          type: string
        retry_after:
          anyOf:
            - type: integer
            - type: 'null'
          description: Seconds to wait before retrying (when applicable).
          title: Retry After
        owner_action_required:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Whether the error requires account owner intervention.
          title: Owner Action Required
        details:
          description: Additional context (validation errors, etc.).
          title: Details
      required:
        - type
        - title
        - status
        - detail
        - error_code
        - timestamp
      title: ErrorOut
      type: object

````