# github.user_starred

**stable** **Advanced**

Repositories starred by a GitHub user.

`GET /v1/github/user_starred`

## What you get

A list of GitHub results in Onekey's unified shape, in `data` (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free `404 not_found` instead.

**Pagination:** 10 results per page. The response carries a `pagination` block; send its `next_cursor` back as the `cursor` parameter to get the next page. Every page is one call at the price below. See [Pagination](https://onekey.dev/docs/pagination.md).

## What it costs

- **Advanced · 5 credits** for a fresh fetch, charged only when it succeeds.
- **Free when served from cache (0.2 credit for a cached response over 100 KB).**
- **Free** if the request is invalid (never charged) or the source fails or reports not found (refunded).

## Parameters

| Name | Type | Required | Default | What it is | Constraints |
| --- | --- | --- | --- | --- | --- |
| `username` | string | yes | (required) | GitHub login | max 39 chars; must match `[a-z0-9](?:[a-z0-9-]{0,38})`; trimmed, leading @ removed, lowercased |
| `cursor` | string | no | - | Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page. | - |

## Request

```bash
curl "https://api.onekey.dev/v1/github/user_starred?username=torvalds" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/github/user_starred",
    params={"username": "torvalds"},
    headers={"x-api-key": "YOUR_API_KEY"},
)
body = res.json()

if body["success"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
```

```javascript
const params = new URLSearchParams({ username: "torvalds" });
const res = await fetch(`https://api.onekey.dev/v1/github/user_starred?${params}`, {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const body = await res.json();

if (body.success) console.log(body.data);
else console.error(body.error.code, body.error.message);
```

## Recorded response

A real GitHub response, recorded and returned in Onekey's shape. Fields the platform does not provide are `null`.

```json
{
  "success": true,
  "data": [
    {
      "entity": {
        "id": "2325298",
        "name": "torvalds/linux",
        "description": "Linux kernel source tree",
        "url": "https://github.com/torvalds/linux",
        "stats": {
          "stars": 250471,
          "forks": 66134,
          "openIssues": 3,
          "watchers": null
        },
        "language": "C",
        "createdAt": "2011-09-04T22:48:12Z",
        "updatedAt": "2026-09-28T20:35:30Z",
        "tags": []
      },
      "package": {
        "pushedAt": "2026-09-27T20:56:06Z",
        "license": "NOASSERTION",
        "defaultBranch": "master",
        "archived": false,
        "homepageUrl": null
      },
      "author": {
        "username": "torvalds",
        "avatarUrl": "https://avatars.githubusercontent.com/u/1024025?v=4"
      }
    },
    {
      "entity": {
        "id": "2319498",
        "name": "subsurface/subsurface",
        "description": "This is the official upstream of the Subsurface divelog program",
        "url": "https://github.com/subsurface/subsurface",
        "stats": {
          "stars": 3190,
          "forks": 604,
          "openIssues": 349,
          "watchers": null
        },
        "language": "C++",
        "createdAt": "2011-09-03T15:27:51Z",
        "updatedAt": "2026-09-28T13:30:36Z",
        "tags": []
      },
      "package": {
        "pushedAt": "2026-09-28T05:39:25Z",
        "license": "GPL-2.0",
        "defaultBranch": "master",
        "archived": false,
        "homepageUrl": "https://subsurface-divelog.org"
      },
      "author": {
        "username": "subsurface",
        "avatarUrl": "https://avatars.githubusercontent.com/u/3876063?v=4"
      }
    }
  ],
  "metadata": {
    "platform": "github",
    "endpoint": "user_starred",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}
```

## Field mapping

How this endpoint's source fields become Onekey's [unified schema](https://onekey.dev/docs/schema.md). Fields the source lacks come back as `null`.

| Source path | Onekey field | Transform |
| --- | --- | --- |
| `id` | `entity.id` | `toString` |
| `full_name` | `entity.name` | - |
| `description` | `entity.description` | - |
| `html_url` | `entity.url` | `safeUrl` |
| `stargazers_count` | `entity.stats.stars` | `toNumber` |
| `forks_count` | `entity.stats.forks` | `toNumber` |
| `open_issues_count` | `entity.stats.openIssues` | `toNumber` |
| `subscribers_count` | `entity.stats.watchers` | `toNumber` |
| `language` | `entity.language` | - |
| `created_at` | `entity.createdAt` | `toIsoDate` |
| `updated_at` | `entity.updatedAt` | `toIsoDate` |
| `pushed_at` | `package.pushedAt` | `toIsoDate` |
| `owner.login` | `author.username` | - |
| `owner.avatar_url` | `author.avatarUrl` | `safeUrl` |
| `license.spdx_id` | `package.license` | - |
| `topics` | `entity.tags` | - |
| `default_branch` | `package.defaultBranch` | - |
| `archived` | `package.archived` | `toBoolean` |
| `homepage` | `package.homepageUrl` | `safeUrl` |

## Caching and freshness

- Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
- Between 2 minutes and 15 minutes the cached copy is still served instantly and marked `stale: true` while Onekey refreshes it in the background.
- If the source is down when a refresh is needed, the last copy can be served for up to 1 hour more (marked stale).
- A "not found" is remembered for 1 minute and is free.
- The cache is shared across all customers, which is what keeps repeat calls cheap.

## What can go wrong

| Status | Code | What to do |
| --- | --- | --- |
| 401 | `unauthorized` | Check the `x-api-key` header. |
| 402 | `insufficient_credits` | [Add credits](https://onekey.dev/pricing); your balance must cover the price. |
| 404 | `not_found` | Unknown endpoint path. |
| 422 | `invalid_params` | Fix the parameters using the table above. Free. |
| 429 | `rate_limited` | Wait `Retry-After` seconds, then retry. |
| 502 | `upstream_error` | The source failed. Refunded; retry with backoff. |

See [Errors](https://onekey.dev/docs/errors.md) for the full list and retry guidance.

Status: stable (verified against the live source).