# Pinterest API
> Real-time Pinterest data as an API — pins, boards and users, returned as clean JSON. Search pins, boards or users by keyword; look up any user's profile with follower, pin and board counts; pull a user's boards and their pins; fetch a pin's details (repins, comments, image, link, domain, pinner) and its related pins; and fetch a board's details and its pins. Live data with titles, descriptions, full-resolution image URLs, outbound links, repin and comment counts, dominant colours and creators. Ideal for social listening and trend research, content aggregation and discovery, e-commerce and visual-marketing tools, and dashboards. 10 data endpoints. Authenticated with an x-oanor-key; fair-use rate limits per plan.

## Authentication
All requests require your oanor API key in the `x-oanor-key` header. Get one at https://www.oanor.com/developer/keys.

```bash
curl -H "x-oanor-key: oanor_live_…" "https://api.oanor.com/pinterest-api/..."
```

## Pricing
- **Free** (Free) — 800 calls/Mo, 3 req/s
- **Starter** ($15/Mo) — 22,000 calls/Mo, 8 req/s
- **Pro** ($49/Mo) — 130,000 calls/Mo, 20 req/s
- **Mega** ($169/Mo) — 700,000 calls/Mo, 45 req/s

## Endpoints

### Search

#### `GET /v1/search/boards` — Search boards

**Parameters:**
- `query` (query, required, string) — Search query Example: `recipes`
- `limit` (query, optional, string) — Max results Example: `25`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/pinterest-api/v1/search/boards?query=recipes&limit=25"
```

#### `GET /v1/search/pins` — Search pins

**Parameters:**
- `query` (query, required, string) — Search query Example: `galaxy`
- `limit` (query, optional, string) — Max results (1–50) Example: `25`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/pinterest-api/v1/search/pins?query=galaxy&limit=25"
```

#### `GET /v1/search/users` — Search users

**Parameters:**
- `query` (query, required, string) — Search query Example: `nasa`
- `limit` (query, optional, string) — Max results Example: `25`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/pinterest-api/v1/search/users?query=nasa&limit=25"
```

### Users

#### `GET /v1/user` — User profile

**Parameters:**
- `username` (query, required, string) — Pinterest username Example: `nasa`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/pinterest-api/v1/user?username=nasa"
```

#### `GET /v1/user/boards` — A user's boards

**Parameters:**
- `username` (query, required, string) — Pinterest username Example: `nasa`
- `limit` (query, optional, string) — Max boards Example: `25`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/pinterest-api/v1/user/boards?username=nasa&limit=25"
```

#### `GET /v1/user/pins` — A user's pins

**Parameters:**
- `username` (query, required, string) — Pinterest username Example: `nasa`
- `limit` (query, optional, string) — Max pins Example: `25`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/pinterest-api/v1/user/pins?username=nasa&limit=25"
```

### Pins

#### `GET /v1/pin` — Pin details

**Parameters:**
- `id` (query, required, string) — Pin id Example: `142567144448722388`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/pinterest-api/v1/pin?id=142567144448722388"
```

#### `GET /v1/pin/related` — Related pins

**Parameters:**
- `id` (query, required, string) — Pin id Example: `142567144448722388`
- `limit` (query, optional, string) — Max pins Example: `25`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/pinterest-api/v1/pin/related?id=142567144448722388&limit=25"
```

### Boards

#### `GET /v1/board` — Board details

**Parameters:**
- `username` (query, required, string) — Board owner username Example: `nasa`
- `slug` (query, required, string) — Board slug Example: `learn-with-nasa`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/pinterest-api/v1/board?username=nasa&slug=learn-with-nasa"
```

#### `GET /v1/board/pins` — A board's pins

**Parameters:**
- `id` (query, required, string) — Board id Example: `142567213143159083`
- `limit` (query, optional, string) — Max pins Example: `25`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/pinterest-api/v1/board/pins?id=142567213143159083&limit=25"
```

### Meta

#### `GET /v1/meta` — Spec

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/pinterest-api/v1/meta"
```


---
Marketplace page: https://www.oanor.com/api/pinterest-api
OpenAPI spec: https://www.oanor.com/api/pinterest-api/openapi.json