Query Pin Requests

org:files:read

GET /files/public/pin_by_cid

Query Pin Requests

cURL

curl --request GET \
  --url https://api.pinata.cloud/v3/files/public/pin_by_cid \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.pinata.cloud/v3/files/public/pin_by_cid"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.pinata.cloud/v3/files/public/pin_by_cid', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.pinata.cloud/v3/files/public/pin_by_cid",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pinata.cloud/v3/files/public/pin_by_cid"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.pinata.cloud/v3/files/public/pin_by_cid")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pinata.cloud/v3/files/public/pin_by_cid")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "data": {
    "jobs": [
      {
        "id": "<string>",
        "cid": "<string>",
        "name": "<string>",
        "status": "<string>",
        "keyvalues": {},
        "host_nodes": [
          "<string>"
        ],
        "group_id": "<string>",
        "date_queued": "<string>"
      }
    ],
    "next_page_token": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

order · enum<string>

Change the order of the results by date_queued

Available options: ASC, DESC

status · enum<string>

Filter pin by CID status

Available options: prechecking, backfilled, retreiving, expired, searching, over_free_limit, over_max_size, invalid_object, bad_host_node

cid · string

Filter queue by CID

limit · string

Limit the number of results returned when querying the queue

pageToken · string

Paginate through pin by cid request results

Response

200 - application/json

OK

data · object

Show child attributes