# gitlab.topic_projects

**stable** **Advanced**

Public GitLab.com projects by topic (most starred first).

`GET /v1/gitlab/topic_projects`

## What you get

A list of GitLab 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.

## 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 |
| --- | --- | --- | --- | --- | --- |
| `topic` | string | yes | (required) | Topic | max 50 chars; must match `[a-z0-9][a-z0-9._-]{0,49}`; trimmed, lowercased |

## Request

```bash
curl "https://api.onekey.dev/v1/gitlab/topic_projects?topic=cli" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/gitlab/topic_projects",
    params={"topic": "cli"},
    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({ topic: "cli" });
const res = await fetch(`https://api.onekey.dev/v1/gitlab/topic_projects?${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 GitLab response, recorded and returned in Onekey's shape. Fields the platform does not provide are `null`.

```json
{
  "success": true,
  "data": [
    {
      "entity": {
        "id": "4180516",
        "name": "antora/antora",
        "description": "A modular documentation site generator that helps you organize and publish content written in AsciiDoc to the web. Ideally suited for users of Asciidoctor.\r\n\r\nThis repository hosts the core software components and documentation for Antora.\r\n\r\nhttps://antora.org",
        "url": "https://gitlab.com/antora/antora",
        "stats": {
          "stars": 597,
          "forks": 380,
          "openIssues": null
        },
        "createdAt": "2017-09-19T00:07:30Z",
        "updatedAt": "2026-09-26T17:33:40Z",
        "tags": [
          "antora",
          "asciidoc",
          "asciidoctor"
        ]
      },
      "package": {
        "defaultBranch": "main"
      },
      "author": {
        "username": "antora",
        "url": "https://gitlab.com/groups/antora"
      },
      "ext": {
        "visibility": "public"
      }
    },
    {
      "entity": {
        "id": "5664378",
        "name": "timvisee/ffsend",
        "description": ":mailbox_with_mail: Easily and securely share files from the command line. A fully featured Firefox Send client.",
        "url": "https://gitlab.com/timvisee/ffsend",
        "stats": {
          "stars": 323,
          "forks": 62,
          "openIssues": null
        },
        "createdAt": "2018-03-06T13:11:22Z",
        "updatedAt": "2025-11-20T08:44:20Z",
        "tags": [
          "cli",
          "encryption",
          "file-sharing"
        ]
      },
      "package": {
        "defaultBranch": "master"
      },
      "author": {
        "username": "timvisee",
        "url": "https://gitlab.com/timvisee"
      },
      "ext": {
        "visibility": "public"
      }
    }
  ],
  "metadata": {
    "platform": "gitlab",
    "endpoint": "topic_projects",
    "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` |
| `path_with_namespace` | `entity.name` | - |
| `description` | `entity.description` | - |
| `web_url` | `entity.url` | `safeUrl` |
| `star_count` | `entity.stats.stars` | `toNumber` |
| `forks_count` | `entity.stats.forks` | `toNumber` |
| `open_issues_count` | `entity.stats.openIssues` | `toNumber` |
| `created_at` | `entity.createdAt` | `toIsoDate` |
| `last_activity_at` | `entity.updatedAt` | `toIsoDate` |
| `default_branch` | `package.defaultBranch` | - |
| `namespace.path` | `author.username` | - |
| `namespace.web_url` | `author.url` | `safeUrl` |
| `topics` | `entity.tags` | - |
| `visibility` | `ext.visibility` | - |

## 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).