# Search github

URL: https://docs.hanzo.ai/docs/openapi/provider/post-provider-github-search

> Finds repositories on GitHub.

`POST /v1/provider/github/search`

> [Provider →](https://docs.hanzo.ai/docs/openapi/provider) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                                  |
| ------------- | ------------------------------------------------ |
| **Address**   | `https://api.hanzo.ai/v1/provider/github/search` |
| **Method**    | `POST`                                           |
| **Operation** | `post_provider_github_search`                    |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`           |

Finds repositories on GitHub.

This reads the PUBLIC index and returns nothing an installation unlocks: it is
how you find a repository to fork, not a way to see inside one. The org's own
token is used only so the query is rate-limited against the installation
rather than anonymously — the results are the same ones anyone would get.

## Request

2 fields, body `application/json` (required).

| Field   | In   | Type            | Required | Description                                                                                               |
| ------- | ---- | --------------- | -------- | --------------------------------------------------------------------------------------------------------- |
| `limit` | body | integer (int64) | —        | Limit caps the answer; 0 takes the default and anything above the ceiling is clamped rather than refused. |
| `q`     | body | string          | —        | Q is GitHub's own search syntax, passed through: "tetris language:go", "org:hanzoai stars:>10".           |

## Response

| Status    | Body                     | Meaning |
| --------- | ------------------------ | ------- |
| `200`     | provider.githubSearchOut | ok      |
| `default` | problem-details          | refused |

`200` body — 10 fields.

| Field                    | In   | Type                        | Always | Description                                                                                                                           |
| ------------------------ | ---- | --------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------- |
| `count`                  | body | integer (int64)             | —      | Count is how many hits Repos carries.                                                                                                 |
| `repos`                  | body | provider.githubSearchHit\[] | —      | Repos are the matching repositories in GitHub's own relevance order, capped at limit.                                                 |
| `repos[].clone_url`      | body | string                      | —      | CloneURL is the repository's https git remote.                                                                                        |
| `repos[].default_branch` | body | string                      | —      | DefaultBranch is the branch a clone checks out.                                                                                       |
| `repos[].description`    | body | string                      | —      | Description is the blurb the repository's owner wrote.                                                                                |
| `repos[].full_name`      | body | string                      | —      | FullName is the repository's "owner/repo" on GitHub.                                                                                  |
| `repos[].html_url`       | body | string                      | —      | HTMLURL is the repository's page on github.com.                                                                                       |
| `repos[].language`       | body | string                      | —      | Language is the primary language GitHub detected from the file mix ("Go", "TypeScript").                                              |
| `repos[].private`        | body | boolean                     | —      | Private is GitHub's visibility flag, passed through.                                                                                  |
| `repos[].stars`          | body | integer (int64)             | —      | Stars is GitHub's stargazers\_count as the SEARCH INDEX held it when the query ran — a snapshot, not a live count off the repository. |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo provider github search
```

**SDK**

**.ts**

```ts
import { Configuration, ProviderApi } from 'hanzoai';

const api = new ProviderApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postProviderGithubSearch({ limit: 0, q: "<q>" });
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import ProviderApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = ProviderApi(client).post_provider_github_search(limit=0, q="<q>")
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.ProviderAPI.PostProviderGithubSearch(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, provider_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = provider_api::post_provider_github_search(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.ProviderApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new ProviderApi(client).postProviderGithubSearch();
```

**HTTP**

```bash
curl -X POST https://api.hanzo.ai/v1/provider/github/search \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "limit": 0,
       "q": "<q>"
     }'
```

**MCP**

MCP reaches **provider** through the `provider` tool, which names its 38 operations with its own verbs — this one among them, under a name only MCP declares. `describe` explains any of them:

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_connections"
         }
       }
     }'
```

---

[Provider API](https://docs.hanzo.ai/docs/openapi/provider) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)