quickstart-ipfs.mdx

title	description	slug	excerpt	hidden
Quickstart	Start uploading and retrieving content in no time	quickstart	Start uploading files with Pinata	false

1. Install and Setup SDK

In the root of your project run the install command with your package manager of choice.

npm i pinata-web3

pnpm i pinata-web3

yarn add pinata-web3

bun i pinata-web3

Import and initialize the SDK in your codebase with the API key and Gateway from the previous step

import { PinataSDK } from "pinata-web3";

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

2. Upload a File

Use the upload method to upload a File object.

import { PinataSDK } from "pinata-web3";

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.file(file);
    console.log(upload);
  } catch (error) {
    console.log(error);
  }
}

await main();

const JWT = "PINATA_JWT";

async function pinFileToIPFS() {
  try {
    const text = "Hello World!";
    const blob = new Blob([text], { type: "text/plain" });
    const file = new File([blob], "hello-world.txt");
    const data = new FormData();
    data.append("file", file);

    const request = await fetch(
      "https://api.pinata.cloud/pinning/pinFileToIPFS",
      {
        method: "POST",
        headers: {
          Authorization: `Bearer ${JWT}`,
        },
        body: data,
      }
    );
    const response = await request.json();
    console.log(response);
  } catch (error) {
    console.log(error);
  }
}

await pinFileToIPFS();

You should get a response object like the one below

{
  IpfsHash: "bafkreibm6jg3ux5qumhcn2b3flc3tyu6dmlb4xa7u5bf44yegnrjhc4yeq",
  PinSize: 20,
  Timestamp: "2024-02-03T18:42:14.989Z"
}

The IpfsHash is more commonly recognized as the CID, both a hash verifying the content’s authenticity but also it serves as the address to the file.

3. Retrieve a File from IPFS

Use the CID or IpfsHash from the upload to fetch a file

import { PinataSDK } from "pinata-web3";

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

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

main();

const GATEWAY = "my-example.mypinata.cloud";
const CID = "bafkreibm6jg3ux5qumhcn2b3flc3tyu6dmlb4xa7u5bf44yegnrjhc4yeq";

async function fetchFileFromIPFS() {
  const url = `https://${GATEWAY}/ipfs/${CID}`;
  try {
    const request = await fetch(url);
    const response = await request.text();
    console.log(response);
  } catch (error) {
    console.log(error);
  }
}

await fetchFileFromIPFS();
// Hello World!

What's Next?

Ready to see more of what Pinata has to offer? Here are some additional features and concepts to help you get the most out of our platform:

Want to learn more about basic IPFS concepts? We have plenty of information for you, including more about [IPFS](/web3/ipfs-101/what-is-ipfs), [Pinning](/web3/ipfs-101/what-is-ipfs-pinning), [CIDs](/web3/ipfs-101/what-are-cids), and [Gateways](/web3/ipfs-101/what-are-ipfs-gateways)!

With Groups, you can organize your files via the Pinata API or the web app. Create a Group, store your IPFS content, and fetch content quickly and easily.

Workspaces allow you to add multiple team members to your Pinata account and collaborate seamlessly. Even if your team members don’t have a Pinata account, you can invite them easily. This feature is essential for efficient project collaboration and management. Gain comprehensive insights into your content with Pinata Analytics. Understanding detailed analytics on requests and bandwidth empower you to make informed decisions, driving your business forward with clear visibility.