> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). The sections below mirror the orientation block in [`/llms.txt`](https://www.socialfetch.dev/llms.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need a structured operation inventory. The catalog covers documented operations with on-site reference pages.

## This page

- **On-site (HTML):** [https://www.socialfetch.dev/docs/api/v1/github/repositories/get](https://www.socialfetch.dev/docs/api/v1/github/repositories/get)
- **Markdown (.mdx) URL:** [https://www.socialfetch.dev/docs/api/v1/github/repositories/get.mdx](https://www.socialfetch.dev/docs/api/v1/github/repositories/get.mdx)

## API base URL and authentication

- **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev`
- **Authentication:** send `x-api-key: sfk_...` on `/v1/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route).
- **OpenAPI JSON:** [https://www.socialfetch.dev/openapi.json](https://www.socialfetch.dev/openapi.json)

## Recommended docs entrypoints (this site)

- [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown).
- [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope.
- [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`.
- [SDK reference](https://www.socialfetch.dev/docs/sdk-reference.mdx) — exhaustive SDK method inventory and route mapping for agents, tooling, and power users.
- [Choose the right endpoint](https://www.socialfetch.dev/docs/choose-endpoint.mdx) — task-oriented route selection for smoke tests, profiles, list endpoints, and single-item lookups.
- [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — fast comparison of identifiers, pagination, outcomes, media download, and SDK coverage.
- [Integrations](https://www.socialfetch.dev/docs/integrations.mdx) — MCP for AI clients, n8n verified node, SDK, and REST API connection paths.
- [MCP integration](https://www.socialfetch.dev/docs/integrations/mcp.mdx) — hosted `/mcp` server, OAuth, Cursor/VS Code/Claude install snippets, 87 endpoint tools, plus docs_search/docs_read for implementation help.
- [n8n integration](https://www.socialfetch.dev/docs/integrations/n8n.mdx) — install `n8n-nodes-socialfetch`, credentials, and workflow examples.
- [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping.
- [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages.
- [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance.
- [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs.
- Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract.

## Markdown docs convention

- Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`).
- Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`).

---
# Get GitHub repository (https://www.socialfetch.dev/docs/api/v1/github/repositories/get)

## Summary

Get a single GitHub repository by URL.

**Tags:** `GitHub`

## HTTP

- **Method:** GET
- **Path:** `/v1/github/repositories`
- **Base URL:** `https://api.socialfetch.dev`

## Capability summary

- **SDK mapping:** `client.github.getRepository({ url })`
- **Accepted identifiers:** `url` (query)
- **Pagination:** none
- **Business outcome field:** `data.lookupStatus` with values `found`, `not_found`

## Credits

- **Base:** 1 credit per successful lookup.
- **Maximum on success (200):** 1 credit.
- **Normalization failure (502):** 1 credit charged.
- **Authoritative field:** `meta.creditsCharged`.

## Authentication

- **`x-api-key`**: API key (`sfk_...`)

## Parameters

### `url` (query)

- **Required:** yes
- **Constraints:** type `string`; minLength: 1; maxLength: 4096
- **Description:** Full public GitHub repository URL.

## Responses (status codes)

- **200**: Repository lookup result. Check `data.lookupStatus` for `found` or `not_found`.
- **400**: Invalid repository URL or bad request
- **401**: Missing or invalid API key
- **402**: Insufficient credits
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed from the response (unexpected or invalid data).
- **503**: Service temporarily unavailable; safe to retry with backoff.

## Response body (200)

Repository lookup result. Check `data.lookupStatus` for `found` or `not_found`.

### Field outline

- **data** (required) — type `object`. Endpoint-specific response payload.
  - **lookupStatus** (required) — type `string`; enum: found, not_found. Whether the repository was found.
  - **repository** (required) — type `object`; nullable. Repository metadata when available.
    - **platformRepoId** (required) — type `string`. GitHub repository id as a string.
    - **nodeId** (optional) — type `string`. GitHub node id when available.
    - **name** (required) — type `string`. Repository name without the owner prefix.
    - **fullName** (required) — type `string`. Full repository name in `owner/repo` form.
    - **owner** (required) — type `object`. Repository owner.
      - **platformUserId** (required) — type `string`. GitHub user or organization id as a string.
      - **handle** (required) — type `string`. GitHub login (username).
      - **avatarUrl** (required) — type `string`; nullable. Avatar image URL for the owner.
      - **profileUrl** (required) — type `string`; minLength: 1. Canonical public GitHub profile URL for the owner.
      - **accountType** (required) — type `string`; enum: User, Organization. Whether the owner is a user or organization.
    - **isPrivate** (required) — type `boolean`. Whether the repository is private.
    - **profileUrl** (required) — type `string`; minLength: 1. Canonical public GitHub repository URL.
    - **description** (required) — type `string`; nullable. Repository description when available.
    - **isFork** (required) — type `boolean`. Whether the repository is a fork.
    - **homepage** (required) — type `string`; nullable. Homepage URL when set on the repository.
    - **language** (required) — type `string`; nullable. Primary programming language when reported.
    - **forksCount** (required) — type `integer`; minimum: 0; nullable. Fork count when available.
    - **starsCount** (required) — type `integer`; minimum: 0; nullable. Star count when available.
    - **watchersCount** (required) — type `integer`; minimum: 0; nullable. Watcher count when available.
    - **sizeKb** (required) — type `integer`; minimum: 0; nullable. Repository size in kilobytes when available.
    - **defaultBranch** (required) — type `string`; nullable. Default branch name when available.
    - **openIssuesCount** (required) — type `integer`; minimum: 0; nullable. Open issue count when available.
    - **topics** (required) — type `array`. Repository topic tags when available.
      - _items:_
        - type `string`
    - **license** (required) — type `object`; nullable. License metadata when available.
      - **key** (required) — type `string`. License key identifier.
      - **name** (required) — type `string`. Human-readable license name.
      - **spdxId** (required) — type `string`; nullable. SPDX license identifier when available.
    - **archived** (required) — type `boolean`. Whether the repository is archived.
    - **disabled** (required) — type `boolean`. Whether the repository is disabled.
    - **visibility** (required) — type `string`; nullable. Repository visibility label when available.
    - **pushedAt** (required) — type `string`; nullable. Last push timestamp (ISO 8601) when available.
    - **createdAt** (required) — type `string`; nullable. Creation timestamp (ISO 8601) when available.
    - **updatedAt** (required) — type `string`; nullable. Last update timestamp (ISO 8601) when available.
- **meta** (required) — type `object`. Metadata describing the request and billing outcome.
  - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call.
  - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request.
  - **version** (required) — type `string`; enum: v1. Public API version that served the response.

### Example JSON (found)

```json
{
  "data": {
    "lookupStatus": "found",
    "repository": {
      "platformRepoId": "2325298",
      "nodeId": "MDEwOlJlcG9zaXRvcnkyMzI1Mjk4",
      "name": "linux",
      "fullName": "torvalds/linux",
      "owner": {
        "platformUserId": "1024025",
        "handle": "torvalds",
        "avatarUrl": "https://avatars.githubusercontent.com/u/1024025?v=4",
        "profileUrl": "https://github.com/torvalds",
        "accountType": "User"
      },
      "isPrivate": false,
      "profileUrl": "https://github.com/torvalds/linux",
      "description": "Linux kernel source tree",
      "isFork": false,
      "homepage": "",
      "language": "C",
      "forksCount": 62741,
      "starsCount": 235824,
      "watchersCount": 235824,
      "sizeKb": 6305272,
      "defaultBranch": "master",
      "openIssuesCount": 3,
      "topics": [],
      "license": {
        "key": "other",
        "name": "Other",
        "spdxId": "NOASSERTION"
      },
      "archived": false,
      "disabled": false,
      "visibility": "public",
      "pushedAt": "2026-06-08T15:03:19Z",
      "createdAt": "2011-09-04T22:48:12Z",
      "updatedAt": "2026-06-08T15:40:20Z"
    }
  },
  "meta": {
    "requestId": "req_01example_github_repository",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Machine-readable error codes

When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime):

- `bad_request`

## Error handling & retries

Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status.

- **400**: Invalid repository URL or bad request **Retry:** Fix the request; retrying the same invalid payload will not help.
- **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help.
- **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help).
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed from the response (unexpected or invalid data). **Retry:** May be transient; a few retries with backoff are reasonable.
- **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter.

### Suggested client defaults

- Send the API key using the `x-api-key` header on every request.
- On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user.
- On `402`, surface an actionable billing message rather than blind retries.

## Examples

### TypeScript SDK

```typescript
import { SocialFetchClient } from "@socialfetch/sdk";

const client = new SocialFetchClient({
  apiKey: process.env.SOCIALFETCH_API_KEY!,
});

const result = await client.github.getRepository({
  url: "https://github.com/torvalds/linux",
});

if (!result.ok) {
  console.error(result.error);
} else {
  console.log(result.value.data);
}
```

### Node.js

```javascript
const response = await fetch(
  "https://api.socialfetch.dev/v1/github/repositories?url=https://github.com/torvalds/linux",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY",
    }
  }
);

const data = await response.json();
console.log(data);
```

### cURL

```bash
curl "https://api.socialfetch.dev/v1/github/repositories?url=https://github.com/torvalds/linux" \
  -H "x-api-key: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://api.socialfetch.dev/v1/github/repositories?url=https://github.com/torvalds/linux",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()
print(data)
```