# GitHub Issue API (https://www.socialcrawl.dev/platforms/github/issue)

> Returns full metadata for an issue or PR — title, body, author, labels, state, reactions, comments count, and timestamps — mapped to the unified Post schema. Pass either an `/issues/N` or `/pull/N` URL; GitHub's API treats them interchangeably under `/issues/N`. Use `/v1/github/issue/comments` for the discussion thread.

TL;DR: `GET /v1/github/issue` costs 1 credit per call and returns SocialCrawl's unified JSON schema. Single x-api-key auth, 100 free credits on signup.

## Parameters

| Parameter | Required | Description |
| --- | --- | --- |
| `url` | yes | GitHub HTML URL — `https://github.com/{owner}/{repo}/issues/{n}` or `/pull/{n}`. |

## Code example

```bash
curl "https://www.socialcrawl.dev/v1/github/issue?url=https%3A%2F%2Fgithub.com%2Ffacebook%2Freact%2Fissues%2F27522" \
  -H "x-api-key: sc_YOUR_API_KEY"
```

## FAQ

### How do I get a single GitHub issue with an API?

Send a GET request to /v1/github/issue with the full issue or pull request URL in the url parameter. SocialCrawl returns that one item — title, body, state, author, labels, assignees, milestone, and comment count — in the unified schema.

### Does this work for pull requests as well as issues?

Yes. Pass either an issue URL or a pull request URL. GitHub models both as issues, so the same endpoint resolves both. The response includes a flag indicating whether the item you fetched is a PR.

### What fields does the GitHub Issue API return?

Issue number, title, body markdown, state (open or closed), author, label list, assignees, milestone, comment count, and creation, update, and closed timestamps. To read the discussion, follow up with the issue comments endpoint.

### How is this different from the repo issues endpoint?

The repo issues endpoint lists many issues for a repository. This endpoint fetches one specific issue or PR by its exact URL — use it when you already have a link and want the full detail for that single item rather than a list.

### How much does the GitHub Issue API cost?

Each request costs 1 credit on the standard tier. New accounts get 100 free credits with no credit card required — enough to pull around 100 individual issues. Pair it with the issue comments endpoint to read the full thread.

See the full GitHub API: https://www.socialcrawl.dev/platforms/github

## Pricing

- Standard endpoints: 1 credit per call
- Advanced endpoints: 5 credits per call
- Premium endpoints: 10 credits per call
- 100 free credits on signup, no credit card required. Cached responses cost 0 credits. Credit packs never expire.
- Full pricing: https://www.socialcrawl.dev/pricing

## Explore with AI

Questions this API answers, phrased for an AI assistant:

- How to get a single GitHub issue or PR with an API
- What does the SocialCrawl GitHub Issue API return?