# SnapEDA Product

## Overview

| Property | Value |
|----------|-------|
| **Status** | active |
| **Method** | `GET` |
| **Endpoint** | `/v2/snapeda/product` |
| **Base URL** | `https://api.piloterr.com` |
| **Credit Cost** | 2 credits per call |
| **Documentation** | https://www.piloterr.com/library/snapeda-product |

## Description

SnapEDA Product API: fetch full part page data from a SnapEDA URL or MPN/manufacturer slug. Returns CAD models, datasheet, RoHS, distributor pricing and availability via browser rendering.

## 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/snapeda/product' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY'
```

## Example Response

### CYPD3175-24LQXQ (Cypress Semiconductor) on snapeda.com

```json
{
  "url": "https://www.snapeda.com/parts/CYPD3175-24LQXQ/Cypress%20Semiconductor/view-part",
  "rohs": true,
  "formats": [
    "Altium",
    "Eagle",
    "KiCAD",
    "Cadence OrCad/Allegro",
    "PADS",
    "DxDesigner",
    "PCB123",
    "Pulsonix",
    "Proteus"
  ],
  "part_id": "2776245",
  "pricing": [
    {
      "price": "37 x $8.30",
      "currency": "USD",
      "quantity": 54954,
      "supplier": "Featured",
      "price_value": 37
    },
    {
      "price": "239 x $1.58 500 x $1.41 1,000 x $1.31 10,000 x $1.17 100,000 x $0.98",
      "currency": "USD",
      "quantity": 1470,
      "supplier": "Verical",
      "price_value": 239
    }
  ],
  "in_stock": true,
  "image_url": "https://snapeda.s3.us-east-1.amazonaws.com/partpics/Cypress Semiconductor_CYPD3175-24L-X-_40408.jpg",
  "cad_models": {
    "symbol": true,
    "model_3d": true,
    "footprint": true
  },
  "description": "ARM® Cortex®-M0 EZ-PD™ CCG3PA USB Type C Microcontroller IC FLASH (64kB) 24-UFQFN Exposed Pad",
  "part_number": "CYPD3175-24LQXQ",
  "availability": "In Stock",
  "manufacturer": "Cypress Semiconductor",
  "datasheet_url": "https://www.snapeda.com/parts/CYPD3175-24LQXQ/Cypress%20Semiconductor/datasheet/"
}
```

## Documentation

## Overview
The **SnapEDA Product API** returns full part page data from SnapMagic Search (ex-SnapEDA). Pass a **part URL** or **`MPN/manufacturer`** slug and receive structured JSON with CAD models, datasheet link, RoHS status, export formats, and distributor pricing.

Piloterr uses **browser rendering** and waits for `#profile-name` before parsing JSON-LD, specs tables, and distributor tables.

Use [SnapEDA Search](https://www.piloterr.com/library/snapeda-search) to discover parts, then [SnapEDA Product](https://www.piloterr.com/library/snapeda-product) for the full record.

## Quickstart
```
GET https://api.piloterr.com/v2/snapeda/product?query=CYPD3175-24LQXQ/Cypress+Semiconductor
GET https://api.piloterr.com/v2/snapeda/product?query=https://www.snapeda.com/parts/CYPD3175-24LQXQ/Cypress%20Semiconductor/view-part/
```

## Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| `query` | string | yes | Part URL or `MPN/manufacturer` |
| `return_page_source` | boolean | no | Rendered HTML as `{"result": "..."}` (default: `false`) |

## Input formats
| Format | Example |
|---|---|
| MPN / manufacturer | `CYPD3175-24LQXQ/Cypress Semiconductor` |
| Full URL | `https://www.snapeda.com/parts/CYPD3175-24LQXQ/Cypress%20Semiconductor/view-part/` |

## Response fields
| Field | Type | Description |
|---|---|---|
| `part_number` | string | MPN (`#profile-name` / JSON-LD) |
| `manufacturer` | string | Manufacturer from specs table |
| `part_id` | string | SnapEDA `unipart_id` |
| `description` | string \| null | `#unipart-shortdesc` |
| `url` | string | Part page URL (tracking params stripped) |
| `image_url` | string \| null | Part photo (`#part-image1`) |
| `in_stock` | boolean \| null | Stock flag |
| `availability` | string \| null | `#availability-info` text |
| `rohs` | boolean \| null | RoHS compliance from specs |
| `cad_models.symbol` | boolean | Symbol available |
| `cad_models.footprint` | boolean | Footprint available |
| `cad_models.model_3d` | boolean | 3D model available |
| `datasheet_url` | string \| null | Link to `/datasheet/` page |
| `formats` | string[] \| null | Exportable CAD formats |
| `pricing[]` | object[] | Distributor rows |
| `pricing[].supplier` | string | Distributor name |
| `pricing[].quantity` | integer \| null | Stock quantity |
| `pricing[].price` | string \| null | Raw price text |
| `pricing[].price_value` | number \| null | First parsed price amount |
| `pricing[].currency` | string \| null | ISO currency |

## SnapEDA workflow
1. [SnapEDA Search](https://www.piloterr.com/library/snapeda-search): discover parts
2. [SnapEDA Product](https://www.piloterr.com/library/snapeda-product): full part JSON (this endpoint)

## Error codes
| Code | Meaning |
|---|---|
| `400` | Missing or invalid `query` |
| `404` | Part not found or unparsable page |
| `500` | Rendering or parsing error |

## Notes
- Manufacturer in product may differ from JSON-LD brand (e.g. Infineon vs Cypress Semiconductor).
- Tracking params (`ref`, `t`, `ab_test_case`, `p`) are stripped from returned URLs.
- Costs **2 credits** per call (browser rendering, up to 90s wait).

## Main use cases
- **BOM enrichment**: datasheet, RoHS, CAD model availability
- **PCB design automation**: export formats and distributor pricing
- **Supply chain intel**: stock and multi-tier pricing tables