> ## 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. # Geocode a free-text address > Resolves a free-text place description (city, postal code, or street address) to coordinates you can pass to `/brands/{brand_id}/locator` as `lat`/`lon`. The lookup runs server-side against Closient's configured geocoder and is cached, so the visitor's browser never contacts the geocoding provider directly. `lat`/`lon` are `null` when nothing matched — that is a successful `200`, not an error. A `502` means the geocoding provider itself was unreachable (`retryable: true`). **Public, unauthenticated**, rate limited by IP more tightly than the rest of this router: a cache miss here costs an outbound request against Closient's geocoding quota. ## OpenAPI ````yaml /openapi/openapi-brands.json get /brands/api/v1/public/geocode 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__ ``` 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/geocode: get: tags: - Brand Locator (Public) summary: Geocode a free-text address description: >- Resolves a free-text place description (city, postal code, or street address) to coordinates you can pass to `/brands/{brand_id}/locator` as `lat`/`lon`. The lookup runs server-side against Closient's configured geocoder and is cached, so the visitor's browser never contacts the geocoding provider directly. `lat`/`lon` are `null` when nothing matched — that is a successful `200`, not an error. A `502` means the geocoding provider itself was unreachable (`retryable: true`). **Public, unauthenticated**, rate limited by IP more tightly than the rest of this router: a cache miss here costs an outbound request against Closient's geocoding quota. operationId: apps_brands_api_public_geocode_for_brand_locator parameters: - in: query name: q schema: description: >- Free-text place description to resolve — a city, postal code, or street address. maxLength: 200 minLength: 1 title: Q type: string required: true description: >- Free-text place description to resolve — a city, postal code, or street address. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GeocodeOut' '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' '422': description: Unprocessable Content content: application/problem+json: schema: $ref: '#/components/schemas/ErrorOut' '429': description: Too Many Requests content: application/problem+json: schema: $ref: '#/components/schemas/ErrorOut' '502': description: Bad Gateway content: application/problem+json: schema: $ref: '#/components/schemas/ErrorOut' components: schemas: GeocodeOut: examples: - display_name: Springfield, Sangamon County, Illinois, United States lat: 39.7817 lon: -89.6501 properties: lat: anyOf: - maximum: 90 minimum: -90 type: number - type: 'null' description: >- Latitude of the best match in decimal degrees, or `null` when nothing matched. title: Lat lon: anyOf: - maximum: 180 minimum: -180 type: number - type: 'null' description: >- Longitude of the best match in decimal degrees, or `null` when nothing matched. title: Lon display_name: default: '' description: >- Human-readable name of the matched place. Empty string when nothing matched. title: Display Name type: string title: GeocodeOut 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 ````