# GitHub on Onekey

> 58 endpoints for GitHub (53 stable, 5 beta), 1 to 5 credits each. Category: Developer platforms. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.
Access: 1 of 58 endpoints are marked "needs a pack" or "may need a pack": free-grant credits reach only the open fetch path; a verified email and a purchased pack unlock the rest.

Page: https://onekey.dev/platforms/github
Reference (Markdown): https://onekey.dev/docs/api/github.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 58 mapped GitHub endpoints return each:

- `author.username` (string): 39
- `content.id` (string): 28
- `content.createdAt` (ISO 8601 date): 25
- `content.url` (URL): 25
- `content.text` (string): 23
- `entity.name` (string): 19
- `content.title` (string): 18
- `engagement.comments` (integer): 16
- `author.avatarUrl` (URL): 15
- `author.id` (string): 11
- `author.url` (URL): 10
- `entity.description` (string): 10
- `entity.id` (string): 10
- `entity.url` (URL): 10
- `content.state` (string): 9
- `content.updatedAt` (ISO 8601 date): 9
- `entity.updatedAt` (ISO 8601 date): 9
- `package.license` (string): 9
- `engagement.likes` (integer): 8
- `entity.stats.openIssues` (integer): 7
- `entity.tags` (list of strings): 7
- `author.displayName` (string): 6
- `author.type` (string): 6
- `entity.createdAt` (ISO 8601 date): 6
- `entity.language` (string): 6
- `entity.stats.forks` (integer): 6
- `entity.stats.stars` (integer): 6
- `entity.stats.watchers` (integer): 6
- `package.defaultBranch` (string): 6
- `package.homepageUrl` (URL): 6
- `package.pushedAt` (ISO 8601 date): 6
- `package.archived` (boolean): 5
- `author.followers` (integer): 2
- `author.following` (integer): 2
- `author.createdAt` (ISO 8601 date): 1
- `author.location` (string): 1
- `author.verified` (boolean): 1
- `author.website` (URL): 1
- `engagement.shares` (integer): 1
- `engagement.votes` (integer): 1
- plus 42 platform-specific fields under `ext.`

## Endpoints

### github.advisories

Global GitHub security advisories (reviewed), filterable by ecosystem.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/advisories` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `ecosystem` (string, optional, default npm): npm, pip, maven, nuget, go, rubygems, composer, rust, erlang, actions, pub, swift
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.title`, `content.url`, `content.createdAt`, `ext.severity`, `ext.cveId`, `ext.cvss`
- Reference: https://onekey.dev/docs/api/github/advisories.md

### github.advisories_graphql

GitHub security advisories via GraphQL (requires a token).
- Price: 5 credits per fresh call. Status: beta. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/advisories_graphql` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `content.id`, `content.title`, `content.url`, `content.createdAt`, `ext.severity`
- Reference: https://onekey.dev/docs/api/github/advisories_graphql.md

### github.advisory

One GitHub security advisory by GHSA id.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/github/advisory?ghsa=GHSA-9wx4-h78v-vm56` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `ghsa` (string, required): GHSA id
- Fields returned: `content.id`, `content.title`, `content.url`, `content.createdAt`, `content.text`, `ext.severity`, `ext.cveId`, `ext.cvss`, `ext.vulnerabilities`
- Reference: https://onekey.dev/docs/api/github/advisory.md

### github.branches

Branches of a GitHub repository.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/branches?owner=facebook&repo=react` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `entity.name`, `ext.commit`, `ext.protected`
- Reference: https://onekey.dev/docs/api/github/branches.md

### github.commit

One GitHub commit with change stats (sha or ref).
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/github/commit?owner=facebook&repo=react&ref=main` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
  - `ref` (string, required): Commit sha or ref (branch/tag)
- Fields returned: `content.id`, `content.text`, `content.url`, `content.createdAt`, `author.displayName`, `author.username`, `engagement.comments`, `ext.additions`, `ext.deletions`, `ext.changes`
- Reference: https://onekey.dev/docs/api/github/commit.md

### github.commits

Recent commits of a GitHub repository.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/commits?owner=facebook&repo=react` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.text`, `content.url`, `content.createdAt`, `author.displayName`, `author.username`, `engagement.comments`
- Reference: https://onekey.dev/docs/api/github/commits.md

### github.community

Community health profile of a GitHub repository.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/github/community?owner=facebook&repo=react` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
- Fields returned: `entity.description`, `entity.updatedAt`, `ext.health`, `ext.contentReportsEnabled`
- Reference: https://onekey.dev/docs/api/github/community.md

### github.contributors

Top contributors of a GitHub repository.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/contributors?owner=facebook&repo=react` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `author.id`, `author.username`, `author.url`, `author.avatarUrl`, `author.type`, `engagement.likes`
- Reference: https://onekey.dev/docs/api/github/contributors.md

### github.forks

Recent forks of a GitHub repository.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/forks?owner=facebook&repo=react` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `entity.id`, `entity.name`, `entity.description`, `entity.url`, `entity.stats.stars`, `entity.stats.forks`, `entity.stats.openIssues`, `entity.stats.watchers`, `entity.language`, `entity.createdAt`, `entity.updatedAt`, `package.pushedAt`, `author.username`, `author.avatarUrl`, `package.license`, `entity.tags`, `package.defaultBranch`, `package.archived`, `package.homepageUrl`
- Reference: https://onekey.dev/docs/api/github/forks.md

### github.gist

One public GitHub gist.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/github/gist?id=6efdf9ca47239507e6a47a208580dc68` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `id` (string, required): Gist id
- Fields returned: `content.id`, `content.text`, `content.url`, `content.createdAt`, `content.updatedAt`, `engagement.comments`, `author.username`
- Reference: https://onekey.dev/docs/api/github/gist.md

### github.issue

One GitHub issue.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/github/issue?owner=facebook&repo=react&number=1` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
  - `number` (string, required): Issue / pull request number
- Fields returned: `content.id`, `content.title`, `content.text`, `content.url`, `content.createdAt`, `content.updatedAt`, `content.state`, `author.username`, `engagement.comments`, `engagement.likes`
- Reference: https://onekey.dev/docs/api/github/issue.md

### github.issue_comments

Comments of a GitHub issue or pull request.
- Price: 1 credit per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/issue_comments?owner=facebook&repo=react&number=1` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
  - `number` (string, required): Issue / pull request number
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.text`, `content.url`, `content.createdAt`, `author.username`, `engagement.likes`
- Reference: https://onekey.dev/docs/api/github/issue_comments.md

### github.issues

Recent issues (and PRs) of a GitHub repository.
- Price: 1 credit per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/issues?owner=facebook&repo=react` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.title`, `content.text`, `content.url`, `content.createdAt`, `content.updatedAt`, `content.state`, `author.username`, `engagement.comments`, `engagement.likes`
- Reference: https://onekey.dev/docs/api/github/issues.md

### github.labels

Labels of a GitHub repository.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/labels?owner=facebook&repo=react` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `entity.id`, `entity.name`, `entity.description`, `ext.color`
- Reference: https://onekey.dev/docs/api/github/labels.md

### github.languages

Language breakdown (bytes) of a GitHub repository.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/github/languages?owner=facebook&repo=react` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
- Fields returned: `ext.languages`
- Reference: https://onekey.dev/docs/api/github/languages.md

### github.latest_release

Latest published release of a GitHub repository.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/github/latest_release?owner=facebook&repo=react` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
- Fields returned: `content.id`, `content.title`, `content.text`, `content.url`, `content.createdAt`, `author.username`, `ext.contentName`, `ext.prerelease`
- Reference: https://onekey.dev/docs/api/github/latest_release.md

### github.license

Detected license of a GitHub repository.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/github/license?owner=facebook&repo=react` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
- Fields returned: `package.license`, `entity.name`, `entity.url`, `ext.path`, `ext.size`
- Reference: https://onekey.dev/docs/api/github/license.md

### github.license_info

Details of one open-source license (permissions, conditions, limitations).
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/github/license_info?key=mit` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `key` (string, required): License key, e.g. mit, apache-2.0
- Fields returned: `entity.id`, `entity.name`, `package.license`, `entity.description`, `entity.url`, `ext.permissions`, `ext.conditions`, `ext.limitations`
- Reference: https://onekey.dev/docs/api/github/license_info.md

### github.licenses

Common open-source licenses known to GitHub.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/licenses` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `entity.id`, `entity.name`, `package.license`, `ext.apiUrl`
- Reference: https://onekey.dev/docs/api/github/licenses.md

### github.milestones

Milestones of a GitHub repository.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/milestones?owner=kubernetes&repo=kubernetes` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.title`, `content.text`, `content.url`, `content.state`, `entity.stats.openIssues`, `ext.closedIssues`, `ext.dueAt`
- Reference: https://onekey.dev/docs/api/github/milestones.md

### github.org

GitHub organisation profile.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/github/org?org=github` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `org` (string, required): GitHub user or organisation login
- Fields returned: `author.id`, `author.username`, `author.displayName`, `content.text`, `author.url`, `author.avatarUrl`, `author.followers`, `author.following`, `engagement.comments`, `author.createdAt`, `author.website`, `author.location`, `author.verified`
- Reference: https://onekey.dev/docs/api/github/org.md

### github.org_events

Recent public events of a GitHub organisation.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/org_events?org=github` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `org` (string, required): GitHub user or organisation login
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.createdAt`, `author.username`, `entity.name`, `ext.action`
- Reference: https://onekey.dev/docs/api/github/org_events.md

### github.org_members

Public members of a GitHub organisation.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/org_members?org=github` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `org` (string, required): GitHub user or organisation login
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `author.id`, `author.username`, `author.url`, `author.avatarUrl`, `author.type`
- Reference: https://onekey.dev/docs/api/github/org_members.md

### github.org_repos

Public repositories of a GitHub organisation (most recently pushed).
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/org_repos?org=github` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `org` (string, required): GitHub user or organisation login
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `entity.id`, `entity.name`, `entity.description`, `entity.url`, `entity.stats.stars`, `entity.stats.forks`, `entity.stats.openIssues`, `entity.stats.watchers`, `entity.language`, `entity.createdAt`, `entity.updatedAt`, `package.pushedAt`, `author.username`, `author.avatarUrl`, `package.license`, `entity.tags`, `package.defaultBranch`, `package.archived`, `package.homepageUrl`
- Reference: https://onekey.dev/docs/api/github/org_repos.md

### github.profile

Fetch a GitHub user's public profile.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/github/profile?username=torvalds` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `username` (string, required): GitHub login, e.g. torvalds
- Fields returned: `author.id`, `author.username`, `author.displayName`, `author.followers`, `author.following`, `engagement.comments`, `author.url`, `content.text`, `author.avatarUrl`
- Reference: https://onekey.dev/docs/api/github/profile.md

### github.public_gists

Most recent public GitHub gists.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/public_gists` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.text`, `content.url`, `content.createdAt`, `content.updatedAt`, `engagement.comments`, `author.username`
- Reference: https://onekey.dev/docs/api/github/public_gists.md

### github.pull

One GitHub pull request with change stats.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/github/pull?owner=facebook&repo=react&number=1` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
  - `number` (string, required): Issue / pull request number
- Fields returned: `content.id`, `content.title`, `content.text`, `content.url`, `content.createdAt`, `content.updatedAt`, `content.state`, `author.username`, `engagement.comments`, `engagement.likes`, `ext.mergedAt`, `ext.sourceBranch`, `ext.additions`, `ext.deletions`, `ext.changedFiles`, `ext.commits`, `ext.merged`
- Reference: https://onekey.dev/docs/api/github/pull.md

### github.pull_commits

Commits of a GitHub pull request.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/pull_commits?owner=facebook&repo=react&number=10000` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
  - `number` (string, required): Issue / pull request number
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.text`, `content.url`, `content.createdAt`, `author.displayName`, `author.username`, `engagement.comments`
- Reference: https://onekey.dev/docs/api/github/pull_commits.md

### github.pull_files

Files changed by a GitHub pull request.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/pull_files?owner=facebook&repo=react&number=10000` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
  - `number` (string, required): Issue / pull request number
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.title`, `content.state`, `content.url`, `ext.additions`, `ext.deletions`, `ext.changes`
- Reference: https://onekey.dev/docs/api/github/pull_files.md

### github.pulls

Recent pull requests of a GitHub repository.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/pulls?owner=facebook&repo=react` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.title`, `content.text`, `content.url`, `content.createdAt`, `content.updatedAt`, `content.state`, `author.username`, `engagement.comments`, `engagement.likes`, `ext.mergedAt`, `ext.sourceBranch`, `ext.draft`
- Reference: https://onekey.dev/docs/api/github/pulls.md

### github.readme

README file descriptor of a GitHub repository (name, path, links).
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/github/readme?owner=facebook&repo=react` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
- Fields returned: `entity.name`, `entity.url`, `ext.path`, `ext.downloadUrl`, `ext.size`, `ext.sha`
- Reference: https://onekey.dev/docs/api/github/readme.md

### github.release_by_tag

A GitHub release by tag name.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/github/release_by_tag?owner=facebook&repo=react&tag=v18.2.0` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
  - `tag` (string, required): Tag name
- Fields returned: `content.id`, `content.title`, `content.text`, `content.url`, `content.createdAt`, `author.username`, `ext.contentName`, `ext.prerelease`
- Reference: https://onekey.dev/docs/api/github/release_by_tag.md

### github.releases

Releases of a GitHub repository.
- Price: 1 credit per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/releases?owner=facebook&repo=react` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.title`, `content.text`, `content.url`, `content.createdAt`, `author.username`, `ext.contentName`, `ext.prerelease`
- Reference: https://onekey.dev/docs/api/github/releases.md

### github.repo

Full metadata of a GitHub repository.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/github/repo?owner=facebook&repo=react` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
- Fields returned: `entity.id`, `entity.name`, `entity.description`, `entity.url`, `entity.stats.stars`, `entity.stats.forks`, `entity.stats.openIssues`, `entity.stats.watchers`, `entity.language`, `entity.createdAt`, `entity.updatedAt`, `package.pushedAt`, `author.username`, `author.avatarUrl`, `package.license`, `entity.tags`, `package.defaultBranch`, `package.archived`, `package.homepageUrl`
- Reference: https://onekey.dev/docs/api/github/repo.md

### github.repo_dossier

Project dossier of a repository: stars, forks, watchers, open issues, license, topics, language, activity dates.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/github/repo_dossier?owner=psf&repo=requests` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `entity.description`, `entity.language`, `entity.stats.stars`, `entity.stats.forks`, `entity.stats.openIssues`, `entity.stats.watchers`, `package.license`, `package.homepageUrl`, `package.defaultBranch`, `entity.tags`, `entity.createdAt`, `entity.updatedAt`, `package.pushedAt`, `author.username`
- Reference: https://onekey.dev/docs/api/github/repo_dossier.md

### github.repo_events

Recent public events of a GitHub repository.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/repo_events?owner=facebook&repo=react` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.createdAt`, `author.username`, `entity.name`, `ext.action`
- Reference: https://onekey.dev/docs/api/github/repo_events.md

### github.repos

List a GitHub user's most recently updated public repositories.
- Price: 1 credit per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/repos?username=torvalds` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `username` (string, required): GitHub login, e.g. torvalds
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.title`, `content.text`, `content.url`, `content.createdAt`, `engagement.likes`, `engagement.shares`, `engagement.comments`, `author.username`, `author.id`
- Reference: https://onekey.dev/docs/api/github/repos.md

### github.search

Search GitHub users by keyword.
- Price: 1 credit per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/search?q=torvalds` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search query
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `author.id`, `author.username`, `author.url`, `author.avatarUrl`
- Reference: https://onekey.dev/docs/api/github/search.md

### github.search_code

Search code across GitHub (requires a token).
- Price: 5 credits per fresh call. Status: beta. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/search_code?q=addClass%20repo%3Ajquery%2Fjquery` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search query
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.title`, `content.url`, `entity.name`, `ext.path`
- Reference: https://onekey.dev/docs/api/github/search_code.md

### github.search_commits

Search GitHub commits.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/search_commits?q=repo%3Atorvalds%2Flinux%20merge` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search query
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.text`, `content.url`, `content.createdAt`, `author.displayName`, `author.username`, `engagement.comments`, `entity.name`
- Reference: https://onekey.dev/docs/api/github/search_commits.md

### github.search_issues

Search GitHub issues and pull requests.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/search_issues?q=is%3Aissue%20is%3Aopen%20react%20hooks` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search query
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.title`, `content.text`, `content.url`, `content.createdAt`, `content.updatedAt`, `content.state`, `author.username`, `engagement.comments`, `engagement.likes`
- Reference: https://onekey.dev/docs/api/github/search_issues.md

### github.search_repos

Search GitHub repositories (most starred first).
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/search_repos?q=language%3Apython%20stars%3A%3E50000` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search query
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `entity.id`, `entity.name`, `entity.description`, `entity.url`, `entity.stats.stars`, `entity.stats.forks`, `entity.stats.openIssues`, `entity.stats.watchers`, `entity.language`, `entity.createdAt`, `entity.updatedAt`, `package.pushedAt`, `author.username`, `author.avatarUrl`, `package.license`, `entity.tags`, `package.defaultBranch`, `package.archived`, `package.homepageUrl`
- Reference: https://onekey.dev/docs/api/github/search_repos.md

### github.search_topics

Search GitHub topics.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/search_topics?q=machine-learning` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search query
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `entity.name`, `entity.description`, `author.username`, `entity.updatedAt`, `ext.title`, `ext.featured`
- Reference: https://onekey.dev/docs/api/github/search_topics.md

### github.stargazers

Recent stargazers of a GitHub repository (requires a token).
- Price: 5 credits per fresh call. Status: beta. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/stargazers?owner=facebook&repo=react` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `author.id`, `author.username`, `author.url`, `author.avatarUrl`, `author.type`
- Reference: https://onekey.dev/docs/api/github/stargazers.md

### github.subscribers

Watchers of a GitHub repository (requires a token).
- Price: 5 credits per fresh call. Status: beta. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/subscribers?owner=facebook&repo=react` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `author.id`, `author.username`, `author.url`, `author.avatarUrl`, `author.type`
- Reference: https://onekey.dev/docs/api/github/subscribers.md

### github.tags

Tags of a GitHub repository.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/tags?owner=facebook&repo=react` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.title`, `content.id`, `ext.zipUrl`
- Reference: https://onekey.dev/docs/api/github/tags.md

### github.top_issues

Most-reacted open issues of a repository (feature requests and complaints ranked by reactions).
- Price: 1 credit per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/top_issues?owner=psf&repo=requests` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
- Fields returned: `content.id`, `content.title`, `content.text`, `content.url`, `content.createdAt`, `content.updatedAt`, `content.state`, `engagement.votes`, `engagement.comments`, `author.username`
- Reference: https://onekey.dev/docs/api/github/top_issues.md

### github.topics

Topics of a GitHub repository.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/github/topics?owner=facebook&repo=react` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
- Fields returned: `entity.tags`
- Reference: https://onekey.dev/docs/api/github/topics.md

### github.user_events

Recent public events of a GitHub user.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/user_events?username=torvalds` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `username` (string, required): GitHub login
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.createdAt`, `author.username`, `entity.name`, `ext.action`
- Reference: https://onekey.dev/docs/api/github/user_events.md

### github.user_followers

Followers of a GitHub user.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/user_followers?username=torvalds` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `username` (string, required): GitHub login
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `author.id`, `author.username`, `author.url`, `author.avatarUrl`, `author.type`
- Reference: https://onekey.dev/docs/api/github/user_followers.md

### github.user_following

Accounts a GitHub user follows.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/user_following?username=gaearon` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `username` (string, required): GitHub login
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `author.id`, `author.username`, `author.url`, `author.avatarUrl`, `author.type`
- Reference: https://onekey.dev/docs/api/github/user_following.md

### github.user_gists

Public gists of a GitHub user.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/user_gists?username=gaearon` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `username` (string, required): GitHub login
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.text`, `content.url`, `content.createdAt`, `content.updatedAt`, `engagement.comments`, `author.username`
- Reference: https://onekey.dev/docs/api/github/user_gists.md

### github.user_orgs

Public organisations of a GitHub user.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/user_orgs?username=gaearon` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `username` (string, required): GitHub login
- Fields returned: `author.id`, `author.username`, `author.avatarUrl`, `content.text`
- Reference: https://onekey.dev/docs/api/github/user_orgs.md

### github.user_profile_velocity

A GitHub user's contribution activity for a year (total contributions).
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/github/user_profile_velocity?handle=torvalds` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `handle` (string, required): GitHub username
- Fields returned: `author.username`, `ext.year`, `ext.totalContributions`
- Reference: https://onekey.dev/docs/api/github/user_profile_velocity.md

### github.user_social_accounts

Social accounts linked to a GitHub profile.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/user_social_accounts?username=gaearon` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `username` (string, required): GitHub login
- Fields returned: `author.url`, `ext.provider`
- Reference: https://onekey.dev/docs/api/github/user_social_accounts.md

### github.user_starred

Repositories starred by a GitHub user.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/user_starred?username=torvalds` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `username` (string, required): GitHub login
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `entity.id`, `entity.name`, `entity.description`, `entity.url`, `entity.stats.stars`, `entity.stats.forks`, `entity.stats.openIssues`, `entity.stats.watchers`, `entity.language`, `entity.createdAt`, `entity.updatedAt`, `package.pushedAt`, `author.username`, `author.avatarUrl`, `package.license`, `entity.tags`, `package.defaultBranch`, `package.archived`, `package.homepageUrl`
- Reference: https://onekey.dev/docs/api/github/user_starred.md

### github.workflow_runs

Recent GitHub Actions runs of a repository.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/workflow_runs?owner=facebook&repo=react` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.title`, `content.state`, `content.url`, `content.createdAt`, `ext.conclusion`, `ext.action`, `ext.ref`, `ext.runNumber`
- Reference: https://onekey.dev/docs/api/github/workflow_runs.md

### github.workflows

GitHub Actions workflows of a repository.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/github/workflows?owner=facebook&repo=react` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): GitHub user or organisation login
  - `repo` (string, required): Repository name
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `entity.updatedAt`, `ext.state`, `ext.path`
- Reference: https://onekey.dev/docs/api/github/workflows.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/github/advisory?ghsa=GHSA-9wx4-h78v-vm56" \
  -H "x-api-key: YOUR_API_KEY"
```