This endpoint lists all contents, whether they are pinned (active), inactive, failed, etc. Important: This is different than the /content/list endpoint, which will only list pinned (active) contents.

Useful for the following scenarios

Retrieve a list of pinned objects and show them on a dashboard or a user interface.
Validate or verify any pinned objects by retrieving the list and evaluating each.

Overview of Pinning

Pinning is a method that allows you to instruct IPFS to store a specific object at a specific location – by default, your local node, though this can be changed if you utilise a third-party remote pinning service. This endpoint lists all of the pinned objects.

Swagger

For more information about this API swagger specification, see here

This page is a work in progress

We will be adding more code examples and more details over time. Thanks for bearing with us and our team! If you have ideas, write us some feedback.

Need more information?

Check out the offical IPFS Pinning documentation. We made sure the follow the standards.

CURL

curl -X GET https://api.estuary.tech/pinning/pins -H "Authorization: Bearer REPLACE_ME_WITH_API_KEY" -H "Accept: application/json"

JavaScript with React

class Example extends React.Component {
  componentDidMount() {
    fetch('https://api.estuary.tech/pinning/pins', {
      method: 'GET',
      headers: {
        Authorization: 'Bearer REPLACE_ME_WITH_API_KEY',
      },

    })
      .then(data => {
        return data.json();
      })
      .then(data => {
        this.setState({ ...data });
      });
  }

  render() {
    return <pre>{JSON.stringify(this.state, null, 1)}</pre>;
  }
}

class Example extends React.Component {
  componentDidMount() {
    fetch('https://api.estuary.tech/pinning/pins', {
      method: 'GET',
      headers: {
        Authorization: 'Bearer REPLACE_ME_WITH_API_KEY',
      },

    })
      .then(data => {
        return data.json();
      })
      .then(data => {
        this.setState({ ...data });
      });
  }

  render() {
    return <pre>{JSON.stringify(this.state, null, 1)}</pre>;
  }
}

Errors

Response

null