# GitHub Repository API

GitHub

Returns a public GitHub repository from its link or owner/name. You get exact star, fork and watcher counts, open issues and open pull requests counted apart, the description, topics, main language, license, homepage, default branch, the owner, the fork it came from, and when it was created and last pushed to. [Overview and pricing](https://socialtap.dev/apis/github/repository/index.md)

GET `/v1/github/repository`

## Example

cURL:

```shell
curl -G 'https://socialtap.dev/v1/github/repository' \
  --data-urlencode 'url=https://github.com/torvalds/linux' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
```

TypeScript SDK:

```typescript
import { SocialTap } from "socialtap";

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

const res = await client.github.repository.get({ url: "https://github.com/torvalds/linux" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);
```

Node.js (fetch):

```javascript
const params = new URLSearchParams({
  url: "https://github.com/torvalds/linux",
});
const res = await fetch(`https://socialtap.dev/v1/github/repository?${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, meta } = body;
console.log(data, meta.credits_charged);
```

Python (requests):

```python
import os

import requests

res = requests.get(
    "https://socialtap.dev/v1/github/repository",
    params={"url": "https://github.com/torvalds/linux"},
    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, meta = body["data"], body["meta"]
print(data, meta["credits_charged"])
```

Go (net/http):

```go
package main

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

func main() {
	q := url.Values{}
	q.Set("url", "https://github.com/torvalds/linux")
	req, err := http.NewRequest("GET", "https://socialtap.dev/v1/github/repository?"+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"`
		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"])
}
```

200 OK:

```json
{
  "data": {
    "approximate_fields": [
      "size_bytes"
    ],
    "avatar_url": null,
    "created_at": "2011-09-04T22:48:12Z",
    "default_branch": "master",
    "description": "Linux kernel source tree",
    "full_name": "torvalds/linux",
    "homepage_url": null,
    "id": "2325298",
    "is_archived": false,
    "is_fork": false,
    "license": {
      "name": "Other",
      "spdx_id": null
    },
    "metrics": {
      "fork_count": 67140,
      "open_issue_count": 0,
      "open_pull_request_count": 3,
      "star_count": 255529,
      "watcher_count": 8563
    },
    "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": false,
        "is_discussions_enabled": false,
        "is_issues_enabled": false,
        "is_mirror": false,
        "is_pages_enabled": false,
        "is_projects_enabled": true,
        "is_pull_requests_enabled": false,
        "is_template": false,
        "is_wiki_enabled": false,
        "language_color": null,
        "license_key": "other",
        "mirror_url": null,
        "network_count": 67140,
        "node_id": "MDEwOlJlcG9zaXRvcnkyMzI1Mjk4",
        "period_star_count": null,
        "source": null
      }
    },
    "programming_language": "C",
    "pushed_at": "2026-11-12T21:21:39Z",
    "size_bytes": 6634523648,
    "topics": [],
    "unknown_fields": [
      "platform_specific.github.built_by"
    ],
    "updated_at": "2026-11-13T01:40:39Z",
    "url": "https://github.com/torvalds/linux"
  },
  "meta": {
    "request_id": "req_3f9c2a7d1e8b4c6a9f0e2d4b6a8c0e1f",
    "platform": "github",
    "source": "api",
    "is_cached": false,
    "credits_charged": 1,
    "latency_ms": 1000,
    "fetched_at": "2026-10-25T12:00:00Z",
    "input": {
      "kind": "repository",
      "id": "2325298",
      "url": "https://github.com/torvalds/linux"
    },
    "credits_remaining": 9999,
    "client_request_id": null,
    "warnings": []
  }
}
```

> [!NOTE]
>
> **Good to know**
>
> - metrics.open_issue_count counts issues alone and metrics.open_pull_request_count pull requests alone. GitHub's own open issue count adds the two together.
> - metrics.watcher_count is the people watching the repository for notifications, not its stars.
> - id is the repository's numeric ID, which stays the same after a rename or a transfer. Send api.github.com/repositories/\<id> as url to read it under whatever name it has now.
> - If GitHub's API refuses, the repository is read from its page. Open issue and pull request counts are then rounded past a thousand and listed in approximate_fields, and the size, language, push date and node ID are null.

## Authorizations

`x-api-key`stringheaderrequired

Your API key. [Authentication](https://socialtap.dev/docs/authentication/index.md)

## Query parameters

| Name | Type | Description | Example |
| --- | --- | --- | --- |
| `url` required | `string`<br>max 2,048 chars | The repository: its link (github.com/torvalds/linux, or any page under it: a file, a folder, its issues or releases), owner/name alone (torvalds/linux), a clone link (https://github.com/torvalds/linux.git, git@github.com:torvalds/linux.git), a file on raw.githubusercontent.com, or the API's link (api.github.com/repos/torvalds/linux, api.github.com/repositories/2325298, by the repository's ID). | `https://github.com/torvalds/linux` |

`url` takes GitHub repository links; another kind of link, or another platform's, fails free with [`invalid_input`](https://socialtap.dev/docs/errors/index.md#invalid_input). Unknown parameters are rejected with a suggestion, never ignored ([Requests](https://socialtap.dev/docs/requests/index.md)).

**Parameters every endpoint accepts**

| Name | Type | Description | Example |
| --- | --- | --- | --- |
| `max_age` optional | `integer`<br>min 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. | — |
| `fields` optional | `string` | 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

### 200

`{data, meta}`. `data` is a [repository](https://socialtap.dev/resources/repository/index.md) object; `meta` describes the request ([meta](https://socialtap.dev/docs/reference/index.md#meta)). Fields only GitHub has are under `platform_specific.github`.

| Field | Type | Description |
| --- | --- | --- |
| `data.platform` | `string` | Platform ID (github, …). |
| `data.id` | `string` | Platform-native repository ID (string): GitHub's number, which stays the same when the repository is renamed or moves to another owner. |
| `data.full_name` | `string` | Owner and name as in its link (torvalds/linux): what people call it, though it changes when the repository is renamed or transferred. |
| `data.name` | `string` | The repository's name without its owner (linux), as its link spells it. |
| `data.url` | `string` (uri) | Canonical repository page URL. |
| `data.avatar_url` | `string` (uri) or `null` | The repository's own icon, apart from its owner's avatar; null when it has none. Platform CDN URLs can expire. |
| `data.description` | `string` or `null` | The repository's short description (GitHub's About), as plain text; null when it has none. |
| `data.owner` | `object` | The account that owns it: a person or an organization (owner_type). |
| `data.owner.id` | `string` or `null` | Platform-native account ID; null when only the handle is known. |
| `data.owner.username` | `string` or `null` | Handle without the @; null when the account has none. |
| `data.owner.display_name` | `string` or `null` | Display name shown on the profile. |
| `data.owner.url` | `string` (uri) or `null` | Canonical profile URL. |
| `data.owner.avatar_url` | `string` (uri) or `null` | Profile picture URL. Platform CDN URLs can expire within hours. |
| `data.owner.is_verified` | `boolean` or `null` | Platform verification badge; null where the platform has no badge. |
| `data.owner_type` | `string` or `null` | 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.<br>One of `person`, `organization` |
| `data.homepage_url` | `string` (uri) or `null` | 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. |
| `data.programming_language` | `string` or `null` | 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. |
| `data.topics` | `string[]` | Topic tags its owner filed it under, as written (lowercase, hyphenated); \[\] when none. |
| `data.license` | `object` or `null` | The license the platform detected in it or its owner declared; null when none is detected or the platform does not say. |
| `data.license.spdx_id` | `string` or `null` | The license's SPDX identifier (MIT, Apache-2.0); null when it has none (a custom or unrecognized license). |
| `data.license.name` | `string` or `null` | 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. |
| `data.default_branch` | `string` or `null` | 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. |
| `data.is_fork` | `boolean` or `null` | A fork of another repository (parent); null when the platform does not say. |
| `data.parent` | `object` or `null` | 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). |
| `data.parent.id` | `string` or `null` | Platform-native repository ID, as Repository.id; null when the platform names the repository without it. |
| `data.parent.full_name` | `string` | Owner and name as in its link (torvalds/linux). |
| `data.parent.url` | `string` (uri) | Canonical repository page URL. |
| `data.is_archived` | `boolean` or `null` | Archived by its owner: read-only, no longer maintained; null when the platform does not say. |
| `data.size_bytes` | `integer` or `null` | 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. |
| `data.created_at` | `string` (date-time) or `null` | When the repository was created, RFC 3339 UTC (a fork's: when it was forked); null when the platform does not say. |
| `data.updated_at` | `string` (date-time) or `null` | 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. |
| `data.pushed_at` | `string` (date-time) or `null` | When code was last pushed to it, RFC 3339 UTC; null when the platform does not say. |
| `data.metrics` | `object` | Counts at fetch time; null = hidden or not exposed, 0 = zero. |
| `data.metrics.star_count` | `integer` or `null` | Accounts that starred it; null when the platform has no stars or hides the count. |
| `data.metrics.fork_count` | `integer` or `null` | Forks of it on the platform; null when the platform does not state a count. |
| `data.metrics.watcher_count` | `integer` or `null` | Accounts watching it for notifications (not its stars); null when the platform does not state a count. |
| `data.metrics.open_issue_count` | `integer` or `null` | 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"). |
| `data.metrics.open_pull_request_count` | `integer` or `null` | Open pull requests (merge requests on GitLab); null when the platform does not state a count. |
| `data.platform_specific` | `object` | Fields only this platform has, under its ID (platform_specific.\<platform>); each null when unknown. |
| `data.platform_specific.github` | `object` or `null` | A GitHub repository's own fields. |
| `data.platform_specific.github.node_id` | `string` or `null` | GitHub's GraphQL node ID of the repository; null when the repository's page answered instead of the API. |
| `data.platform_specific.github.license_key` | `string` or `null` | 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. |
| `data.platform_specific.github.is_disabled` | `boolean` or `null` | True when GitHub disabled the repository (it no longer serves its code); null when the repository's page answered. |
| `data.platform_specific.github.is_template` | `boolean` or `null` | True when its owner made it a template that new repositories can be generated from. |
| `data.platform_specific.github.is_mirror` | `boolean` or `null` | True when it is a mirror GitHub keeps in sync with a repository hosted elsewhere. |
| `data.platform_specific.github.mirror_url` | `string` or `null` | The repository it mirrors, when it is a mirror; null otherwise and when the repository's page answered. |
| `data.platform_specific.github.is_issues_enabled` | `boolean` or `null` | Whether its issue tracker is on; null when the repository's page answered. |
| `data.platform_specific.github.is_pull_requests_enabled` | `boolean` or `null` | Whether it takes pull requests (its owner can turn them off); null when not stated. |
| `data.platform_specific.github.is_discussions_enabled` | `boolean` or `null` | Whether its Discussions forum is on; null when the repository's page answered. |
| `data.platform_specific.github.is_wiki_enabled` | `boolean` or `null` | Whether its wiki is on; null when the repository's page answered. |
| `data.platform_specific.github.is_projects_enabled` | `boolean` or `null` | Whether its project boards are on; null when the repository's page answered. |
| `data.platform_specific.github.is_pages_enabled` | `boolean` or `null` | Whether it publishes a GitHub Pages website; null when the repository's page answered. |
| `data.platform_specific.github.network_count` | `integer` or `null` | Repositories in its fork network (every fork of its root repository, forks of forks included); null in a list of repositories. |
| `data.platform_specific.github.source` | `object` or `null` | 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. |
| `data.platform_specific.github.source.id` | `string` or `null` | Platform-native repository ID, as Repository.id; null when the platform names the repository without it. |
| `data.platform_specific.github.source.full_name` | `string` | Owner and name as in its link (torvalds/linux). |
| `data.platform_specific.github.source.url` | `string` (uri) | Canonical repository page URL. |
| `data.platform_specific.github.period_star_count` | `integer` or `null` | 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. |
| `data.platform_specific.github.built_by` | `object[]` | 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. |
| `data.platform_specific.github.built_by[].id` | `string` or `null` | Platform-native account ID; null when only the handle is known. |
| `data.platform_specific.github.built_by[].username` | `string` or `null` | Handle without the @; null when the account has none. |
| `data.platform_specific.github.built_by[].display_name` | `string` or `null` | Display name shown on the profile. |
| `data.platform_specific.github.built_by[].url` | `string` (uri) or `null` | Canonical profile URL. |
| `data.platform_specific.github.built_by[].avatar_url` | `string` (uri) or `null` | Profile picture URL. Platform CDN URLs can expire within hours. |
| `data.platform_specific.github.built_by[].is_verified` | `boolean` or `null` | Platform verification badge; null where the platform has no badge. |
| `data.platform_specific.github.language_color` | `string` or `null` | 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. |
| `data.approximate_fields` | `string[]` | 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. |
| `data.unknown_fields` | `string[]` | 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: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `invalid_input` | 400 | No | 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. |

### 401

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

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `unauthorized` | 401 | No | 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.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `insufficient_credits` | 402 | No | 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. |
| `spend_limit_reached` | 402 | No | 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.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `forbidden` | 403 | No | 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](mailto:support@socialtap.dev). 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. |
| `private_or_unavailable` | 403 | No | 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.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `not_found` | 404 | No | 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.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `rate_limited` | 429 | Yes, 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](mailto:support@socialtap.dev) to raise the ceiling; without an API key, send one. |

### 451

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

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `unavailable_for_legal_reasons` | 451 | No | We removed this item after a copyright notice or another legal request, so we don't return it. The request was free. A list leaves such items out instead, with an items_omitted warning. | Do not retry. The item stays unavailable unless the notice is withdrawn. |

### 500

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

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `internal` | 500 | Yes, later | An unexpected error on SocialTap's side. | Retry with backoff. If it keeps happening, contact [support](mailto:support@socialtap.dev) with the request_id. |

### 502

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

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `upstream_error` | 502 | Yes, 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.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `upstream_blocked` | 503 | Yes, later | The platform refused every attempt, our own retries included. | Retry later with backoff. Failed requests are free. |
| `overloaded` | 503 | Yes, 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. |

## Pricing

From **1 credit** per request. Charged only for successful requests. Errors are free. The price depends on the source that produced the result, reported as `meta.source`; sources are tried cheapest first: Platform API → Public page.

| Source | Price per successful request | Per 1,000 requests |
| --- | --- | --- |
| Platform API `api` | 1 credit | $0.75–$1.97 |
| Public page `page` | 1 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`](https://socialtap.dev/docs/errors/index.md#insufficient_credits) (HTTP 402) and costs nothing. Only that minimum is set aside when the request starts.

| meta.source | Source | What it means |
| --- | --- | --- |
| `api` | Platform API | The platform's public, logged-out API. |
| `page` | Public page | Data embedded in the platform's public web page. |

`meta.credits_charged` and the `x-credits-charged` header show what you paid. [How credits work](https://socialtap.dev/docs/credits/index.md) · [Packs](https://socialtap.dev/pricing/index.md)

Endpoint ID `github.repository` · operationId `github.repository.get` · [Product overview](https://socialtap.dev/apis/github/repository/index.md)

---

[HTML version](https://socialtap.dev/docs/reference/github/repository/) · [Docs index for AI agents](https://socialtap.dev/llms.txt) · [All docs in one file](https://socialtap.dev/llms-full.txt)
