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

# Pinto quickstart

> Install @traceryn/pinto and read a pin, a profile, and a board.

## Requirements

* Node.js 18 or later

## Install

```bash npm theme={null}
npm install @traceryn/pinto
```

```bash yarn theme={null}
yarn add @traceryn/pinto
```

## Read your first data

```ts theme={null}
import { createPinto } from "@traceryn/pinto";

const pinto = createPinto();

// Read a pin: accepts a full URL, a /pin/<id>/ path, a short link, or a bare ID.
const pin = await pinto.getPin("https://pin.it/67v3VVvF2");
console.log(pin.id, pin.image, pin.isVideo ? "video" : "image");

// Read a profile.
const user = await pinto.getUser("https://www.pinterest.com/Corex2410/");
console.log(user.username, user.followers);

// Read a board and its pins.
const board = await pinto.getBoard(
  "https://www.pinterest.com/Corex2410/black-white-symbols/",
);
const pins = await pinto.boardPins(board.url, { pageSize: 50 });
console.log(board.name, pins.results.length, pins.hasMore);
```

## Run the example

The repository includes a full example in [`Example/example.ts`](https://github.com/Traceryn/Pinto/blob/master/Example/example.ts).

```bash theme={null}
git clone https://github.com/Traceryn/Pinto.git
cd Pinto
npm install
npm run example
```

## Next steps

> [card] [Reading pins](https://traceryn.online/pinto/pins.md)
>
> Every field on a pin.

> [card] [Search](https://traceryn.online/pinto/search.md)
>
> Paginated search across pins, boards, users, and videos.


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