GitHub

GitHub Pinned Repositories API

Returns the repositories a GitHub user or organization pinned to its profile, from its username, account ID or link, in the order it chose. Each comes with its permanent ID, owner, description, main language, stars, forks, and whether it is a fork, archived or a template. Overview and pricing

GET /v1/github/pinned_repositories

Try it

Example

cURL
curl 'https://socialtap.dev/v1/github/pinned_repositories?handle=torvalds' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
TypeScript SDK
import { SocialTap } from "socialtap";

const client = new SocialTap(); // apiKey defaults to process.env.SOCIALTAP_API_KEY

const res = await client.github.pinnedRepositories.list({ handle: "torvalds" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);
Node.js (fetch)
const params = new URLSearchParams({
  handle: "torvalds",
});
const res = await fetch(`https://socialtap.dev/v1/github/pinned_repositories?${params}`, {
  headers: { "x-api-key": process.env.SOCIALTAP_API_KEY ?? "" },
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
const { data, page, meta } = body;
console.log(data, meta.credits_charged);
Python (requests)
import os

import requests

res = requests.get(
    "https://socialtap.dev/v1/github/pinned_repositories",
    params={"handle": "torvalds"},
    headers={"x-api-key": os.environ["SOCIALTAP_API_KEY"]},
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
data, page, meta = body["data"], body["page"], body["meta"]
print(data, meta["credits_charged"])
Go (net/http)
package main

import (
	"encoding/json"
	"fmt"
	"log"
	"net/http"
	"net/url"
	"os"
)

func main() {
	q := url.Values{}
	q.Set("handle", "torvalds")
	req, err := http.NewRequest("GET", "https://socialtap.dev/v1/github/pinned_repositories?"+q.Encode(), nil)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("x-api-key", os.Getenv("SOCIALTAP_API_KEY"))
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer res.Body.Close()
	var body struct {
		Data  json.RawMessage `json:"data"`
		Page  json.RawMessage `json:"page"`
		Meta  map[string]any  `json:"meta"`
		Error *struct {
			Code    string `json:"code"`
			Message string `json:"message"`
		} `json:"error"`
	}
	if err := json.NewDecoder(res.Body).Decode(&body); err != nil {
		log.Fatal(err)
	}
	if body.Error != nil {
		log.Fatalf("%s: %s", body.Error.Code, body.Error.Message)
	}
	fmt.Println(string(body.Data), body.Meta["credits_charged"])
}
PHP
<?php

$query = http_build_query([
    'handle' => 'torvalds',
]);
$ch = curl_init('https://socialtap.dev/v1/github/pinned_repositories?' . $query);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['x-api-key: ' . getenv('SOCIALTAP_API_KEY')],
]);
$body = json_decode(curl_exec($ch), true);
if (curl_getinfo($ch, CURLINFO_RESPONSE_CODE) >= 400) {
    throw new RuntimeException($body['error']['code'] . ': ' . $body['error']['message']);
}
print_r($body['data']);
echo $body['meta']['credits_charged'], PHP_EOL;
Ruby
require "json"
require "net/http"

uri = URI("https://socialtap.dev/v1/github/pinned_repositories")
uri.query = URI.encode_www_form('handle' => 'torvalds')
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = ENV.fetch("SOCIALTAP_API_KEY")
res = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") { |http| http.request(req) }
body = JSON.parse(res.body)
raise "#{body["error"]["code"]}: #{body["error"]["message"]}" unless res.is_a?(Net::HTTPSuccess)
pp body["data"]
puts body["meta"]["credits_charged"]
Java
import java.net.URI;
import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;

public class Main {
    public static void main(String[] args) throws Exception {
        String query = "handle=" + encode("torvalds");
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://socialtap.dev/v1/github/pinned_repositories?" + query))
            .header("x-api-key", System.getenv("SOCIALTAP_API_KEY"))
            .GET()
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        // An error is {"error": {"code", "message", ...}}; success is {data, meta}, meta.credits_charged its price.
        if (response.statusCode() >= 400) throw new RuntimeException(response.body());
        System.out.println(response.body());
    }

    static String encode(String value) {
        return URLEncoder.encode(value, StandardCharsets.UTF_8);
    }
}
.NET
using System.Text.Json;

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("x-api-key", Environment.GetEnvironmentVariable("SOCIALTAP_API_KEY"));

var query = string.Join("&",
    "handle=" + Uri.EscapeDataString("torvalds"));
var res = await http.GetAsync("https://socialtap.dev/v1/github/pinned_repositories?" + query);
using var body = JsonDocument.Parse(await res.Content.ReadAsStringAsync());
if (!res.IsSuccessStatusCode)
{
    var error = body.RootElement.GetProperty("error");
    throw new Exception($"{error.GetProperty("code")}: {error.GetProperty("message")}");
}
Console.WriteLine(body.RootElement.GetProperty("data"));
Console.WriteLine(body.RootElement.GetProperty("meta").GetProperty("credits_charged"));
Rust
// Cargo.toml: reqwest = { version = "0.12", features = ["blocking", "json"] }, serde_json = "1"
use std::env;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let res = reqwest::blocking::Client::new()
        .get("https://socialtap.dev/v1/github/pinned_repositories")
        .query(&[("handle", "torvalds")])
        .header("x-api-key", env::var("SOCIALTAP_API_KEY")?)
        .send()?;
    let ok = res.status().is_success();
    let body: serde_json::Value = res.json()?;
    if !ok {
        return Err(format!("{}: {}", body["error"]["code"], body["error"]["message"]).into());
    }
    println!("{} {}", body["data"], body["meta"]["credits_charged"]);
    Ok(())
}
200 OK
{
  "data": [
    {
      "approximate_fields": [
        "metrics.star_count",
        "metrics.fork_count"
      ],
      "avatar_url": null,
      "created_at": null,
      "default_branch": null,
      "description": "Linux kernel source tree",
      "full_name": "torvalds/linux",
      "homepage_url": null,
      "id": "2325298",
      "is_archived": false,
      "is_fork": false,
      "license": null,
      "metrics": {
        "fork_count": 67100,
        "open_issue_count": null,
        "open_pull_request_count": null,
        "star_count": 256000,
        "watcher_count": null
      },
      "name": "linux",
      "owner": {
        "avatar_url": "https://avatars.githubusercontent.com/u/1024025?v=4",
        "display_name": null,
        "id": "1024025",
        "is_verified": null,
        "url": "https://github.com/torvalds",
        "username": "torvalds"
      },
      "owner_type": "person",
      "parent": null,
      "platform": "github",
      "platform_specific": {
        "github": {
          "built_by": [],
          "is_disabled": null,
          "is_discussions_enabled": null,
          "is_issues_enabled": null,
          "is_mirror": null,
          "is_pages_enabled": null,
          "is_projects_enabled": null,
          "is_pull_requests_enabled": null,
          "is_template": false,
          "is_wiki_enabled": null,
          "language_color": null,
          "license_key": null,
          "mirror_url": null,
          "network_count": null,
          "node_id": null,
          "period_star_count": null,
          "source": null
        }
      },
      "programming_language": "C",
      "pushed_at": null,
      "size_bytes": null,
      "topics": [],
      "unknown_fields": [
        "topics",
        "platform_specific.github.built_by",
        "platform_specific.github.built_by"
      ],
      "updated_at": null,
      "url": "https://github.com/torvalds/linux"
    },
    {
      "approximate_fields": [
        "metrics.star_count"
      ],
      "avatar_url": null,
      "created_at": null,
      "default_branch": null,
      "description": "Linus learns analog circuits",
      "full_name": "torvalds/GuitarPedal",
      "homepage_url": null,
      "id": "1058343058",
      "is_archived": false,
      "is_fork": false,
      "license": null,
      "metrics": {
        "fork_count": 133,
        "open_issue_count": null,
        "open_pull_request_count": null,
        "star_count": 2500,
        "watcher_count": null
      },
      "name": "GuitarPedal",
      "owner": {
        "avatar_url": "https://avatars.githubusercontent.com/u/1024025?v=4",
        "display_name": null,
        "id": "1024025",
        "is_verified": null,
        "url": "https://github.com/torvalds",
        "username": "torvalds"
      },
      "owner_type": "person",
      "parent": null,
      "platform": "github",
      "platform_specific": {
        "github": {
          "built_by": [],
          "is_disabled": null,
          "is_discussions_enabled": null,
          "is_issues_enabled": null,
          "is_mirror": null,
          "is_pages_enabled": null,
          "is_projects_enabled": null,
          "is_pull_requests_enabled": null,
          "is_template": false,
          "is_wiki_enabled": null,
          "language_color": null,
          "license_key": null,
          "mirror_url": null,
          "network_count": null,
          "node_id": null,
          "period_star_count": null,
          "source": null
        }
      },
      "programming_language": "C",
      "pushed_at": null,
      "size_bytes": null,
      "topics": [],
      "unknown_fields": [
        "topics",
        "platform_specific.github.built_by",
        "platform_specific.github.built_by"
      ],
      "updated_at": null,
      "url": "https://github.com/torvalds/GuitarPedal"
    },
    {
      "approximate_fields": [
        "metrics.star_count"
      ],
      "avatar_url": null,
      "created_at": null,
      "default_branch": null,
      "description": "Random version of microemacs with my private modificatons",
      "full_name": "torvalds/uemacs",
      "homepage_url": null,
      "id": "117900805",
      "is_archived": false,
      "is_fork": false,
      "license": null,
      "metrics": {
        "fork_count": 326,
        "open_issue_count": null,
        "open_pull_request_count": null,
        "star_count": 2200,
        "watcher_count": null
      },
      "name": "uemacs",
      "owner": {
        "avatar_url": "https://avatars.githubusercontent.com/u/1024025?v=4",
        "display_name": null,
        "id": "1024025",
        "is_verified": null,
        "url": "https://github.com/torvalds",
        "username": "torvalds"
      },
      "owner_type": "person",
      "parent": null,
      "platform": "github",
      "platform_specific": {
        "github": {
          "built_by": [],
          "is_disabled": null,
          "is_discussions_enabled": null,
          "is_issues_enabled": null,
          "is_mirror": null,
          "is_pages_enabled": null,
          "is_projects_enabled": null,
          "is_pull_requests_enabled": null,
          "is_template": false,
          "is_wiki_enabled": null,
          "language_color": null,
          "license_key": null,
          "mirror_url": null,
          "network_count": null,
          "node_id": null,
          "period_star_count": null,
          "source": null
        }
      },
      "programming_language": "C",
      "pushed_at": null,
      "size_bytes": null,
      "topics": [],
      "unknown_fields": [
        "topics",
        "platform_specific.github.built_by",
        "platform_specific.github.built_by"
      ],
      "updated_at": null,
      "url": "https://github.com/torvalds/uemacs"
    }
  ],
  "page": {
    "has_more": false,
    "next_cursor": null,
    "next_cursor_expires_at": null,
    "end_reason": "platform_limit"
  },
  "meta": {
    "request_id": "req_3f9c2a7d1e8b4c6a9f0e2d4b6a8c0e1f",
    "platform": "github",
    "source": "page",
    "is_cached": false,
    "credits_charged": 1,
    "latency_ms": 1000,
    "fetched_at": "2026-10-25T12:00:00Z",
    "input": {
      "kind": "profile",
      "id": "1024025",
      "url": "https://github.com/torvalds"
    },
    "credits_remaining": 9999,
    "client_request_id": null,
    "warnings": []
  }
}

Long arrays and strings are shortened for display; real responses are complete.

x-api-keystringheaderrequired

Your API key. Authentication

handlestringrequiredmax 2,048 chars

The GitHub user or organization: its username, with or without the @; its numeric account ID, which survives a rename; or its profile link (github.com/torvalds, with any tab, github.com/orgs/vercel/repositories).

Exampletorvalds

limitintegermin 1max 6

Items per page, 1 to the endpoint's page size (its default and maximum; larger values are reduced to it). Omit it: every page costs the same, so a smaller limit means more pages to pay for.

Example6

cursorstring

page.next_cursor from the previous response. Send the same other parameters; omit to start from the first page.

handle takes GitHub profile links; another kind of link, or another platform's, fails free with invalid_input. Unknown parameters are rejected with a suggestion, never ignored (Requests). limit and cursor page through the list: see Pagination.

Parameters every endpoint accepts
max_ageintegermin 0

Accept a cached response up to this many seconds old. Cache hits cost 0 credits. Omit to always fetch fresh. The Cache-Control: max-age=N request header is equivalent; max_age wins when both are sent.

fieldsstring

Return only these fields of each item: comma-separated paths in the schema's notation (id,text,metrics.view_count,segments[].text; a parent path keeps the whole object). Unknown paths are rejected. Applied after the cache, so it changes neither the price nor cache hits; page and meta are always returned whole.

Response

application/json

200

{data, page, meta}. data is an array of up to 6 repository objects, the order the account pinned them in; page says how to get the next page; meta describes the request (meta). Fields only GitHub has are under platform_specific.github.

platformstring

Platform ID (github, …).

idstring

Platform-native repository ID (string): GitHub's number, which stays the same when the repository is renamed or moves to another owner.

full_namestring

Owner and name as in its link (torvalds/linux): what people call it, though it changes when the repository is renamed or transferred.

namestring

The repository's name without its owner (linux), as its link spells it.

urlstring uri

Canonical repository page URL.

avatar_urlstring urinullable

The repository's own icon, apart from its owner's avatar; null when it has none. Platform CDN URLs can expire.

descriptionstringnullable

The repository's short description (GitHub's About), as plain text; null when it has none.

ownerobject

The account that owns it: a person or an organization (owner_type).

ShowHide 6 child fields
idstringnullable

Platform-native account ID; null when only the handle is known.

usernamestringnullable

Handle without the @; null when the account has none.

display_namestringnullable

Display name shown on the profile.

urlstring urinullable

Canonical profile URL.

avatar_urlstring urinullable

Profile picture URL. Platform CDN URLs can expire within hours.

is_verifiedbooleannullable

Platform verification badge; null where the platform has no badge.

owner_typestringnullable

Whether the owner is a person's account or an organization's (a GitHub organization, a GitLab group, a Bitbucket team); null when the platform does not say. New values may be added.

One ofpersonorganization

homepage_urlstring urinullable

The project's website as its owner set it, as an absolute URL (https:// added to a bare example.com); null when none is set or it is not a web address.

programming_languagestringnullable

The repository's main programming or markup language as the platform names it (Go, C++, Jupyter Notebook), by the size of its files; null when the platform detects none.

topicsstring[]

Topic tags its owner filed it under, as written (lowercase, hyphenated); [] when none.

licenseobjectnullable

The license the platform detected in it or its owner declared; null when none is detected or the platform does not say.

ShowHide 2 child fields
spdx_idstringnullable

The license's SPDX identifier (MIT, Apache-2.0); null when it has none (a custom or unrecognized license).

namestringnullable

The license's name as the platform shows it (MIT License; Other for one the platform cannot identify); null when it shows only the identifier.

default_branchstringnullable

The branch its page shows and pull requests target by default (main, master); null when the repository is empty or the platform does not say.

is_forkbooleannullable

A fork of another repository (parent); null when the platform does not say.

parentobjectnullable

The repository it was forked from; null when it is not a fork or the source does not name it (a list of repositories says only is_fork).

ShowHide 3 child fields
idstringnullable

Platform-native repository ID, as Repository.id; null when the platform names the repository without it.

full_namestring

Owner and name as in its link (torvalds/linux).

urlstring uri

Canonical repository page URL.

is_archivedbooleannullable

Archived by its owner: read-only, no longer maintained; null when the platform does not say.

size_bytesintegernullable

How much the repository stores on the platform, its history included, in bytes; listed in approximate_fields when the platform states kilobytes. Null when it does not say.

created_atstring date-timenullable

When the repository was created, RFC 3339 UTC (a fork's: when it was forked); null when the platform does not say.

updated_atstring date-timenullable

When anything about the repository last changed as the platform counts it (on GitHub a new star counts), RFC 3339 UTC; pushed_at says when its code did. Null when the platform does not say.

pushed_atstring date-timenullable

When code was last pushed to it, RFC 3339 UTC; null when the platform does not say.

metricsobject

Counts at fetch time; null = hidden or not exposed, 0 = zero.

ShowHide 5 child fields
star_countintegernullable

Accounts that starred it; null when the platform has no stars or hides the count.

fork_countintegernullable

Forks of it on the platform; null when the platform does not state a count.

watcher_countintegernullable

Accounts watching it for notifications (not its stars); null when the platform does not state a count.

open_issue_countintegernullable

Open issues, pull requests not counted (0 when its issue tracker is off); null when the platform does not state it apart from them. Listed in approximate_fields when read from display text ("1.1k").

open_pull_request_countintegernullable

Open pull requests (merge requests on GitLab); null when the platform does not state a count.

platform_specificobject

Fields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.

ShowHide 1 child field
githubobjectnullable

A GitHub repository's own fields.

ShowHide 17 child fields
node_idstringnullable

GitHub's GraphQL node ID of the repository; null when the repository's page answered instead of the API.

license_keystringnullable

GitHub's own key for the detected license (mit, apache-2.0, other); null when no license is detected or the repository's page answered.

is_disabledbooleannullable

True when GitHub disabled the repository (it no longer serves its code); null when the repository's page answered.

is_templatebooleannullable

True when its owner made it a template that new repositories can be generated from.

is_mirrorbooleannullable

True when it is a mirror GitHub keeps in sync with a repository hosted elsewhere.

mirror_urlstringnullable

The repository it mirrors, when it is a mirror; null otherwise and when the repository's page answered.

is_issues_enabledbooleannullable

Whether its issue tracker is on; null when the repository's page answered.

is_pull_requests_enabledbooleannullable

Whether it takes pull requests (its owner can turn them off); null when not stated.

is_discussions_enabledbooleannullable

Whether its Discussions forum is on; null when the repository's page answered.

is_wiki_enabledbooleannullable

Whether its wiki is on; null when the repository's page answered.

is_projects_enabledbooleannullable

Whether its project boards are on; null when the repository's page answered.

is_pages_enabledbooleannullable

Whether it publishes a GitHub Pages website; null when the repository's page answered.

network_countintegernullable

Repositories in its fork network (every fork of its root repository, forks of forks included); null in a list of repositories.

sourceobjectnullable

The root repository of its fork chain (parent is the one it was forked from directly); null when it is not a fork, and in a list of repositories.

ShowHide 3 child fields
idstringnullable

Platform-native repository ID, as Repository.id; null when the platform names the repository without it.

full_namestring

Owner and name as in its link (torvalds/linux).

urlstring uri

Canonical repository page URL.

period_star_countintegernullable

Stars it gained in the trending board's window (today, this week or this month, as asked): what GitHub ranks the board by; null outside the trending board.

built_byobject[]

The contributors GitHub's trending board shows for it (Built by, up to five, most active first). Only the trending board shows them: elsewhere it is [] and listed in unknown_fields.

ShowHide 6 child fields
idstringnullable

Platform-native account ID; null when only the handle is known.

usernamestringnullable

Handle without the @; null when the account has none.

display_namestringnullable

Display name shown on the profile.

urlstring urinullable

Canonical profile URL.

avatar_urlstring urinullable

Profile picture URL. Platform CDN URLs can expire within hours.

is_verifiedbooleannullable

Platform verification badge; null where the platform has no badge.

language_colorstringnullable

The color GitHub draws programming_language's dot in, as a hex code (#3572A5 for Python); null when the source does not show it or the language has none.

approximate_fieldsstring[]

JSON paths of values rounded by the platform or parsed from display text (size_bytes from kilobytes, metrics.open_issue_count from "1.1k"). [] when all exact.

unknown_fieldsstring[]

JSON paths of lists whose [] means unknown rather than none (a source that cannot see the topics); null already means unknown for every other field. [] when every list is known.

not_found and private_or_unavailable are item-level: the request was fine, the item can't be returned.

400

400 Bad Request: 2 error codes. Free: errors cost nothing.

A parameter is missing or malformed, or the link is not one this endpoint takes.

Fix the parameter named in param as the message says. For a link of the wrong kind, call an endpoint listed in details.endpoints, when there is one.

The cursor is malformed or expired, belongs to another endpoint, or came with other parameters than the request that returned it.

Repeat the original request without cursor to start the list again.

401

401 Unauthorized: 1 error code. Free: errors cost nothing.

unauthorizedNo retry

The x-api-key header is missing, or its key is unknown or revoked. On the dashboard's routes: the session cookie is missing or expired.

Send a valid API key in the x-api-key header. No key yet? A person gets one at details.signup_url; an AI agent follows details.agent_auth_url.

402

402 Payment Required: 2 error codes. Free: errors cost nothing.

The account does not have enough credits for this request.

Have a person buy credits at details.purchase_url (or make them a checkout link with details.checkout), then repeat the request. Do not retry automatically.

The API key reached its spend limit for this period. The account may still have credits.

Wait until details.resets_at, or raise the key's spend limit (PATCH /v1/api_keys/{id}). Do not retry automatically.

403

403 Forbidden: 2 error codes. Free: errors cost nothing.

forbiddenNo retry

The API key is valid but may not make this request, and details.reason says why: the account is suspended, the key lacks the route's scope, has expired, or was used from an IP outside its allowlist, or a rotated key's previous secret was used for a call that needs the admin scope. A running job stops with it too when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item: a private item is private_or_unavailable, also 403, so branch on the code.

Act on details.reason. suspended: contact support. scope: use a key with details.required_scope. previous_secret: use the new secret. key_expired or key_revoked: create a new key. ip_not_allowed: call from an allowed IP.

The item exists but is not public: it is private, age- or region-restricted, or needs a login to view. It shares 403 with forbidden (which is about the key), so branch on the code.

Only public items can be fetched. Do not retry.

404

404 Not Found: 1 error code. Free: errors cost nothing.

not_foundNo retry

The item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why).

Check the link or ID. Do not retry.

429

429 Too Many Requests: 1 error code. Free: errors cost nothing.

rate_limitedYes, later

The account passed its runaway-protection ceiling: a high per-account limit that stops a broken client loop (plans have no rate limit). Requests without an API key (signup, the MCP server's tool listing and find_endpoint) are limited per IP address instead. It also stops an account whose failed requests in the last hour cost far more than its successful ones paid for: failures are free within a limit (the message says so), and successes raise it.

Wait the seconds in the retry-after header, then retry. If your steady traffic needs more, ask support to raise the ceiling; without an API key, send one.

451

451: 1 error code. Free: errors cost nothing.

500

500 Internal Error: 1 error code. Free: errors cost nothing.

internalYes, later

An unexpected error on SocialTap's side.

Retry with backoff. If it keeps happening, contact support with the request_id.

502

502 Bad Gateway: 1 error code. Free: errors cost nothing.

upstream_errorYes, later

The platform failed, or answered with something we could not read.

Retry with backoff. Failed requests are free.

503

503 Unavailable: 2 error codes. Free: errors cost nothing.

The platform refused every attempt, our own retries included.

Retry later with backoff. Failed requests are free.

overloadedYes, later

SocialTap was at capacity, or paused by its operators, and did not start the request. Nothing was fetched or charged.

Retry after the seconds in the retry-after header. Failed requests are free.

Items come in pages, the order the account pinned them in. To get the next page, send the same request plus cursor set to page.next_cursor from the previous response. Keep every other parameter the same (limit, max_age and fields may change); anything else that differs is rejected. When page.has_more is false the walk is over, and page.end_reason says why: only end means you have every item (the others say the platform or a page cap stopped the walk early).

Order
The order the account pinned them in
Page size
Up to 6 repos (the default; limit lowers it)
Cursor lifetime
24 hours; don't store cursors
Price
Per page, 1 credit

The page object

has_moreboolean

True when another page exists; then next_cursor is set. An empty page with has_more true is not the end.

next_cursorstringnullable

Pass as cursor, with the same other parameters, to get the next page; null at the end.

next_cursor_expires_atstring date-timenullable

When next_cursor stops working, RFC 3339 UTC; null at the end. Don't store cursors.

end_reasonstringnullable

Why there are no more pages; null while has_more is true. end: the list ended, or reached since/until. platform_limit: the platform stops serving further pages although the list goes on. max_pages: SocialTap's cap on pages in one walk. New values may be added. A short or empty page is not the end: only has_more false is.

One ofendplatform_limitmax_pages

Next page

cURL: next page
curl 'https://socialtap.dev/v1/github/pinned_repositories?handle=torvalds&cursor=NEXT_CURSOR' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
  • The price is per page: each successful page costs the same, whatever limit is and however many items it has. Empty pages are charged too (an empty page with has_more: true is not the end).
  • A limit below 6 doesn't save credits: the next request serves the rest of the same platform page, which is fetched again and charged as a page each time, and items can shift between those requests if the platform changes the list. Omitting limit is the cheapest way to walk the list.
  • Errors are free, including a rejected cursor.
  • Pages served from the cache are free.
  • An expired or altered cursor, or one sent with different parameters, fails with invalid_cursor (HTTP 400): Repeat the original request without cursor to start the list again.

Pagination guide

From 1 credit per page. Charged per successful page, whatever its number of items. Errors are free. The price depends on the source that produced the result, reported as meta.source.

SourcePrice per successful pagePer 1,000 pages
Public page page1 credit$0.75–$1.97
Balance, sources and what you were charged

Your balance must be at least 1 credit to start a request; with less, it is refused with insufficient_credits (HTTP 402) and costs nothing. Only that minimum is set aside when the request starts.

meta.sourceSourceWhat it means
pagePublic pageData embedded in the platform's public web page.

meta.credits_charged and the x-credits-charged header show what you paid. How credits work · Packs

Endpoint ID github.pinned_repositories · operationId github.pinned_repositories.list · Product overview

Last updated