---
title: "Search GitHub history"
method: GET
path: "/search/research/github"
tags: ["Research"]
---

# Search GitHub history

`GET /search/research/github`

## Query parameters

- `query` string, required
- `k` integer

## Response `200`

Ranked GitHub history/readme results.

- ResearchGitHubSearchResponse
  - `success` boolean, required
  - `results` ResearchGitHubItem[], required
    - `resultType` string — Result class, such as issue, pull, discussion, or repo_readme.
    - `repo` string — Repository in owner/name form.
    - `url` string, uri
    - `pageType` string — History page type for issue/PR/discussion results.
    - `number` integer
    - `segmentCount` integer
    - `readmeUrl` string, uri
    - `title` string
    - `snippet` string
    - `contentMd` string — Full matched markdown content when available.
    - `scores` ResearchGitHubScoreBreakdown — Component scores such as semantic, lexical, fusion, rrf, or rerank.

## Other responses

- `400` — Invalid request
- `401` — Missing or invalid bearer token
- `429` — Rate limit exceeded
- `500` — Internal server error

---

[API](https://skmtc.dev/firecrawl/apis/firecrawl-api.md) · [All operations](https://skmtc.dev/firecrawl/apis/firecrawl-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/firecrawl/firecrawl-api/revisions/e350fafb5a2a/schema)