Pinata

!cover-image

The new all-in-one Pinata SDK

Quickstart

View the full documentation here

$3

``bash
npm i pinata
`

Import and initialize the SDK in your codebase with the following variables
- Pinata API Key JWT
- Pinata Gateway Domain

`typescript
import { PinataSDK } from "pinata";

const pinata = new PinataSDK({
pinataJwt: "PINATA_JWT",
pinataGateway: "example-gateway.mypinata.cloud",
});
`

The PINATA_JWT is a secret key, be sure to initialize the SDK in a secure environment and practice basic variable security practices. If you need to upload from a client environment, consider using signed JWTs

$3

`typescript
import { PinataSDK } from "pinata";

const pinata = new PinataSDK({
pinataJwt: process.env.PINATA_JWT!,
pinataGateway: "example-gateway.mypinata.cloud",
});

async function main() {
try {
const file = new File(["hello"], "Testing.txt", { type: "text/plain" });
const upload = await pinata.upload.public.file(file);
console.log(upload);
} catch (error) {
console.log(error);
}
}

await main();
`

This will return an object like the following:

`typescript
{
id: "0195a5c4-242f-7c01-bee8-f34a9e8e804b",
user_id: "87ef31fe-519b-4ffe-90d9-987771247827",
group_id: null,
name: "hello.txt",
cid: "bafkreid7qoywk77r7rj3slobqfekdvs57qwuwh5d2z3sqsw52iabe3mqne",
created_at: "2025-03-17T20:20:50.057Z",
size: 12,
number_of_files: 1,
mime_type: "text/plain",
vectorized: false,
network: "public",
}
`

$3

Use the cid or from the upload to fetch a file

`typescript
import { PinataSDK } from "pinata";

const pinata = new PinataSDK({
pinataJwt: process.env.PINATA_JWT!,
pinataGateway: "example-gateway.mypinata.cloud",
});

async function main() {
try {
const data = await pinata.gateways.public.get("bafkreibm6jg3ux5qumhcn2b3flc3tyu6dmlb4xa7u5bf44yegnrjhc4yeq");
console.log(data)
} catch (error) {
console.log(error);
}
}

main();
`

View the full documentation here

Developing

`bash
git clone https://github.com/PinataCloud/pinata
cd pinata
npm install
`

Run Build
`bash
npm run build
`

Run Tests
`bash
npm run test
``