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

# Géocodage adresse (BAN)

> Base Adresse Nationale, sans clé. q minimum 3 caractères.



## OpenAPI

````yaml /openapi.json get /v1/search/address
openapi: 3.1.0
info:
  title: Urbanora Partner API
  description: >-
    API partenaire Urbanora — façade HTTP authentifiée par clé API
    (`X-Api-Key`). Erreurs : `{ error: { code, message }, request_id }`.
    Rate-limit : 60 req/min (burst 20) ; 429 `RATE_LIMIT_EXCEEDED` + headers
    `X-RateLimit-*`.
  version: 1.0.0
servers:
  - url: https://partner.urbanora.fr
    description: Production
  - url: http://127.0.0.1:8086
    description: Développement
security:
  - apiKey: []
tags:
  - name: meta
    description: Sources et usage
  - name: buildings
    description: Qualification d'immeuble
  - name: imb
    description: IMB / fibre
  - name: copros
    description: Copropriétés
  - name: syndics
    description: Syndics
  - name: search
    description: Recherche et géocodage
  - name: zones
    description: Territoire
  - name: contacts
    description: Contacts
paths:
  /v1/search/address:
    get:
      tags:
        - search
      summary: Géocodage adresse (BAN)
      description: Base Adresse Nationale, sans clé. q minimum 3 caractères.
      parameters:
        - schema:
            type: string
            minLength: 1
          in: query
          name: q
          required: true
          description: Texte de recherche.
        - schema:
            type: integer
            minimum: 1
            maximum: 20
          in: query
          name: limit
          required: false
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - query
                  - results
                properties:
                  query:
                    type: string
                  results:
                    type: array
                    items:
                      type: object
                      additionalProperties: false
                      required:
                        - lon
                        - lat
                      properties:
                        label:
                          type:
                            - string
                            - 'null'
                        type:
                          type:
                            - string
                            - 'null'
                        city:
                          type:
                            - string
                            - 'null'
                        citycode:
                          type:
                            - string
                            - 'null'
                        postcode:
                          type:
                            - string
                            - 'null'
                        score:
                          type:
                            - number
                            - 'null'
                        lon:
                          type: number
                        lat:
                          type: number
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - error
                  - request_id
                properties:
                  error:
                    type: object
                    additionalProperties: false
                    required:
                      - code
                      - message
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                  request_id:
                    type: string
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - error
                  - request_id
                properties:
                  error:
                    type: object
                    additionalProperties: false
                    required:
                      - code
                      - message
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                  request_id:
                    type: string
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - error
                  - request_id
                properties:
                  error:
                    type: object
                    additionalProperties: false
                    required:
                      - code
                      - message
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                  request_id:
                    type: string
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - error
                  - request_id
                properties:
                  error:
                    type: object
                    additionalProperties: false
                    required:
                      - code
                      - message
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                  request_id:
                    type: string
        '429':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - error
                  - request_id
                properties:
                  error:
                    type: object
                    additionalProperties: false
                    required:
                      - code
                      - message
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                  request_id:
                    type: string
        '501':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - error
                  - request_id
                properties:
                  error:
                    type: object
                    additionalProperties: false
                    required:
                      - code
                      - message
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                  request_id:
                    type: string
        '503':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - error
                  - request_id
                properties:
                  error:
                    type: object
                    additionalProperties: false
                    required:
                      - code
                      - message
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                  request_id:
                    type: string
      security:
        - apiKey: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-Api-Key
      description: >-
        Clé API partenaire (`upk_live_…` / `upk_test_…`). Alias MCP :
        `Authorization: Bearer upk_…`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.