IPFS

IPFS is a distributed file storage. You can store data to IPFS and read from them.

Get file from IPFS

1 credit per API call.


Gets data from the IPFS.

SecurityX-API-Key
Request
path Parameters
id
required
string

IPFS CID of the file

Example: QmXJJ6UF5WkF4WTJvsdhiA1etGwBLfpva7Vr9AudGMe3pj
Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.

500

Internal server error. There was an error on the server while processing the request.

get/v3/ipfs/{id}
Request samples
curl -i -X GET \
  'https://api-eu1.tatum.io/v3/ipfs/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "errorCode": "validation.failed",
  • "message": "Request validation failed. Please see data for additional information.",
  • "statusCode": 400,
  • "data": [
    ]
}

Store data to IPFS

2 credits per API call. Only files up to 50MB are available for storing.


Stores file on the IPFS. We are leveraging nft.storage from Protocol Labs for free storage on the IPFS.

SecurityX-API-Key
Request
Request Body schema: multipart/form-data
file
string <binary>

Your file to store

Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.

500

Internal server error. There was an error on the server while processing the request.

post/v3/ipfs
Request samples
curl -i -X POST \
  https://api-eu1.tatum.io/v3/ipfs \
  -H 'Content-Type: multipart/form-data' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -F file=127654187631872620
Response samples
application/json
{
  • "ipfsHash": "string"
}