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

# Lister les commerces locaux

> Listez les observations d’commerces locaux extraites des réponses enregistrées.

Renvoie les observations d’commerces locaux extraites des réponses enregistrées. Chaque enregistrement est une observation, pas une recommandation vérifiée ni une fiche d’établissement à jour.

<ParamField header="Authorization" type="string" required>
  Jeton bearer. Exemple : `Bearer qw-api-xxx`
</ParamField>

```http theme={null}
GET /api/v1/brands/{brandId}/local
```

## Paramètres de chemin

<ParamField path="brandId" type="string" required>
  L’identifiant unique de la marque
</ParamField>

## Paramètres de requête

<ParamField query="period" type="number">
  Nombre de jours à inclure. Sans valeur, toutes les données sont renvoyées.
</ParamField>

<ParamField query="startDate" type="string">
  Date de début au format `YYYY-MM-DD`. Fournissez-la avec `endDate` ; une borne seule est actuellement ignorée. Choisissez soit `period`, soit la paire de dates complète.
</ParamField>

<ParamField query="endDate" type="string">
  Date de fin au format `YYYY-MM-DD`. Fournissez-la avec `startDate` ; une borne seule est actuellement ignorée. Ne combinez pas la paire de dates complète avec `period`.
</ParamField>

<ParamField query="provider" type="string">
  Filtre par un ou plusieurs alias de fournisseurs ou identifiants de modèles, séparés par des virgules.
</ParamField>

<ParamField query="category" type="string">
  Filtre par catégorie d’établissement (correspondance partielle, sans tenir compte de la casse)
</ParamField>

<ParamField query="limit" type="number" default="50">
  Nombre maximal d’établissements renvoyés (maximum : 100)
</ParamField>

<ParamField query="offset" type="number" default="0">
  Nombre de résultats à ignorer pour la pagination
</ParamField>

<ParamField query="sort" type="string" default="createdAt">
  Champ de tri : `createdAt`, `rating`, `reviewCount`, `position`, `businessName`
</ParamField>

<ParamField query="order" type="string" default="desc">
  Ordre de tri : `asc` ou `desc`
</ParamField>

## Réponse

<ResponseField name="success" type="boolean">
  Indique si la requête a réussi
</ResponseField>

<ResponseField name="pagination" type="object">
  <Expandable title="Informations de pagination">
    <ResponseField name="total" type="number">Nombre total d’établissements correspondant aux filtres</ResponseField>
    <ResponseField name="count" type="number">Nombre d’établissements dans cette réponse</ResponseField>
    <ResponseField name="limit" type="number">Nombre maximal d’éléments par page</ResponseField>
    <ResponseField name="offset" type="number">Nombre d’éléments ignorés</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="local" type="array">
  <Expandable title="Objet commerce local">
    <ResponseField name="id" type="string">Identifiant de l’observation locale</ResponseField>
    <ResponseField name="businessName" type="string">Nom de l’établissement</ResponseField>
    <ResponseField name="category" type="string">Catégorie de l’établissement</ResponseField>
    <ResponseField name="address" type="string">Adresse de l’établissement</ResponseField>
    <ResponseField name="websiteUrl" type="string">URL du site de l’établissement</ResponseField>
    <ResponseField name="position" type="number">Position dans la liste (1 = premier résultat)</ResponseField>
    <ResponseField name="rating" type="number">Note de l’établissement (0 à 5)</ResponseField>
    <ResponseField name="reviewCount" type="number">Nombre d’avis</ResponseField>
    <ResponseField name="prompt" type="string">Prompt associé à l’observation enregistrée</ResponseField>
    <ResponseField name="createdAt" type="string">Horodatage ISO 8601</ResponseField>
  </Expandable>
</ResponseField>

## Exemple de requête

```bash theme={null}
curl -X GET "https://www.qwairy.co/api/v1/brands/cm1234567890abcdef/local?category=restaurant&limit=10" \
  -H "Authorization: Bearer qw-api-your-token-here"
```

## Exemple de réponse

```json theme={null}
{
  "success": true,
  "pagination": {
    "total": 42,
    "count": 2,
    "limit": 10,
    "offset": 0
  },
  "local": [
    {
      "id": "loc1",
      "businessName": "Northstar Café",
      "category": "Café",
      "address": "10 Example Street, Paris",
      "websiteUrl": "https://cafe.northstar.example",
      "position": 1,
      "rating": 4.8,
      "reviewCount": 2500,
      "prompt": "Which cafés are mentioned near the example district?",
      "createdAt": "2026-07-15T10:30:00Z"
    },
    {
      "id": "loc2",
      "businessName": "Orbit Bistro",
      "category": "Restaurant",
      "address": "20 Example Avenue, Paris",
      "websiteUrl": "https://bistro.orbit.example",
      "position": 2,
      "rating": 4.5,
      "reviewCount": 1800,
      "prompt": "Which cafés are mentioned near the example district?",
      "createdAt": "2026-07-15T10:30:00Z"
    }
  ]
}
```

## Erreurs

| Statut | Code | Description |
| - | - | - |
| 400 | `INVALID_PARAMETER` | Valeur de filtre, de pagination ou de tri invalide |
| 401 | erreur de passerelle | Échec de l’authentification |
| 404 | `BRAND_NOT_FOUND` | Marque inexistante ou inaccessible |
| 429 | erreur de passerelle | Limite de débit dépassée ; respectez `Retry-After` |


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