Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cardano IPFS » Pins API

The IPFS » Pins API from Cardano — 4 operation(s) for ipfs » pins.

Cardano IPFS » Pins API is one of 21 APIs that Cardano publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include IPFS » Pins. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and rate-limit docs.

This API exposes 4 operations across 4 paths. It is described by OpenAPI 3.0.3, at version 0.1.89.

Requests are made against 4 base URLs: https://cardano-mainnet.blockfrost.io/api/v0, https://cardano-preprod.blockfrost.io/api/v0, https://cardano-preview.blockfrost.io/api/v0, https://localhost:3000.

4 operations 4 paths 0 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
0.1.89
Base URL
https://cardano-mainnet.blockfrost.io/api/v0
Authentication
API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Cardano IPFS » Pins API declares 1 security scheme for authenticating requests. An API key is passed in the header as project_id (project_id). By default, every request must be authenticated.

  • project_id — There are multiple token types available based on network you choose when creating a Blockfrost a project, for a list of token types see available networks.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

IPFS » Pins 4
POST
/ipfs/pin/add/{IPFS_path}
Pin an object
2 params → 200400403404418425429500
GET
/ipfs/pin/list
List pinned objects
3 params → 200400403404418429500
GET
/ipfs/pin/list/{IPFS_path}
Get details about pinned object
1 param → 200400403404418429500
POST
/ipfs/pin/remove/{IPFS_path}
Remove a IPFS pin
1 param → 200400403404418429500

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cardano-ipfs-pins-api-openapi.yml Raw ↑

Other APIs Cardano publishes across the network.

Blockfrost IPFS API
Cardano Cardano » Accounts API
Cardano Cardano » Addresses API
Cardano Cardano » Assets API
Cardano Cardano » Blocks API
Cardano Cardano » Epochs API
Cardano Cardano » Governance API
Cardano Cardano » Ledger API
Cardano Cardano » Mempool API
Cardano Cardano » Metadata API
Cardano Cardano » Network API
Cardano Cardano » Pools API