# BigMat Search

## Overview

| Property | Value |
|----------|-------|
| **Status** | private |
| **Method** | `GET` |
| **Endpoint** | `/v2/bigmat/search` |
| **Base URL** | `https://api.piloterr.com` |
| **Credit Cost** | 1 credit per call |
| **Documentation** | https://www.piloterr.com/library/bigmat-search |

## Description

Access real-time BigMat product data for market analysis and streamlined e-commerce with our API.

## Authentication

- **Key Name:** `x-api-key`
- **Location:** HTTP Header
- **Get an API key:** https://app.piloterr.com/register

## Example Request

```bash
curl --location --request GET 'https://api.piloterr.com/v2/bigmat/search' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY'
```

## Example Response

### Example

```json
{
  "products": [
    {
      "name": "MADRIER SAPIN DU NORD BRUT 27X250MM 4M",
      "price": "31.85",
      "category": "Charpente bois",
      "imageUrl": "https://www.bigmat.fr/shop/media/catalog/product/s/a/sapin_du_nord.jpg",
      "description": "Madrier sapin du Nord, brut, longueur 4m, largeur 27cm, épaisseur 2.5cm."
    },
    {
      "name": "POUTRE I SOLIVETTE 3600 MM",
      "price": "Etude sur devis",
      "category": "Charpente bois",
      "imageUrl": "https://www.bigmat.fr/shop/media/catalog/product/p/o/poutre_i_solivette.jpg",
      "description": "Poutre I solivette, longueur 3.6m. Adapté pour la structure solide en bois."
    },
    {
      "name": "PLAN DE CHARPENTE COMBLES",
      "price": "5.00",
      "category": "Charpente bois",
      "imageUrl": "https://www.bigmat.fr/shop/media/catalog/product/p/l/plan_charpente_combles.jpg",
      "description": "Plans de charpente pour aménagement de combles."
    }
  ]
}
```

## Documentation

## Overview
Access real-time BigMat product data for market analysis and streamlined e-commerce with our API.

## Quickstart
```
GET https://api.piloterr.com/v2/bigmat/search?query=example
```

## Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| `query` | string | yes | Search query or target identifier |

## Main use cases
- Integrate BigMat Search data into enrichment, analytics, and monitoring pipelines
- Automate large-scale extraction from Bigmat without maintaining scrapers
- Power internal dashboards and workflow automations with live Bigmat data