List package documentation pages

GET

packages

{registry}

{name}

docs

GET /v1/packages/npm/express/docs HTTP/1.1
Host: api.githits.dev
Authorization: Bearer <token>

{
  "code_index_state": "current",
  "indexing_ref": null,
  "package": {
    "name": "example",
    "registry": "npm",
    "version": "1.0.0"
  },
  "page_info": {
    "end_cursor": "Mg==",
    "has_next_page": true,
    "total_count": 3
  },
  "pages": [
    {
      "docs_read_target": "https://docs.example.org/guide?a=1#setup",
      "file_path": null,
      "git_ref": null,
      "id": "page-42",
      "last_updated_at": null,
      "repo_url": null,
      "requested_ref": null,
      "source_kind": "crawled",
      "source_url": "https://docs.example.org/guide?a=1#setup",
      "title": "Getting started"
    },
    {
      "docs_read_target": "opaque-repo-snapshot-id",
      "file_path": "README.md",
      "git_ref": "0123456789abcdef0123456789abcdef01234567",
      "id": "opaque-repo-snapshot-id",
      "last_updated_at": null,
      "repo_url": "https://github.com/example/project",
      "requested_ref": "main",
      "source_kind": "repo",
      "source_url": null,
      "title": "README"
    }
  ],
  "stale": false,
  "target_resolution": {
    "freshness": "current",
    "freshness_reason": "exact_current",
    "indexing_ref": null,
    "requested": {
      "commit_sha": null,
      "git_ref": null,
      "kind": "package_omitted_version",
      "name": "example",
      "registry": "npm",
      "repo_url": null,
      "version": null
    },
    "resolved_requested": {
      "commit_sha": "0123456789abcdef0123456789abcdef01234567",
      "git_ref": "0123456789abcdef0123456789abcdef01234567",
      "kind": null,
      "name": "example",
      "registry": "npm",
      "repo_url": "https://github.com/example/project",
      "version": "1.0.0"
    },
    "served": {
      "commit_sha": "0123456789abcdef0123456789abcdef01234567",
      "git_ref": "0123456789abcdef0123456789abcdef01234567",
      "kind": null,
      "name": "example",
      "registry": "npm",
      "repo_url": "https://github.com/example/project",
      "version": "1.0.0"
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-GitHits-Client-Name

string

Optional client attribution: trimmed printable ASCII, at most 80 bytes. Invalid optional values are dropped.

X-GitHits-Client-Version

string

Optional client-version attribution: trimmed printable ASCII, at most 80 bytes. Invalid optional values are dropped.

X-GitHits-Agent

string

Optional agent attribution: trimmed printable ASCII, at most 160 bytes. Invalid optional values are dropped.

X-GitHits-Session-ID

string

Optional session attribution: trimmed printable ASCII, at most 128 bytes. Invalid optional values are dropped; no session is created.

Path Parameters

registry

enum<string>

required

Exact lowercase registry identifier; no trimming or case normalization.

Available options:

npm,

pypi,

hex,

crates,

vcpkg,

zig,

nuget,

maven,

packagist,

rubygems,

go,

swift

name

string

required

Nonempty package name, at most 255 UTF-8 bytes without control characters. Spelling and whitespace are preserved; the response reports the resolved canonical name. Encode slashes within one path segment.

Minimum string length: 1

Query Parameters

version

string

Optional package version. Whitespace is trimmed; blank is treated as omitted. GitHits resolves an omitted version. Numeric Go versions gain lowercase v; leading v/V is accepted for resolution. The returned version may differ from the input.

limit

integer

default:100

Maximum returned rows, default 100, integer 1–500. Does not bound upstream preparation work.

Required range: 1 <= x <= 500

after

string

Opaque trimmed nonblank cursor, passed unchanged. Not snapshot-bound; upstream may reset malformed tokens to zero.

Minimum string length: 1

Response

One page of documentation summaries and source lifecycle

One page of source-owned documentation summaries, with no global readiness assertion.

code_index_state

enum<string>

required

Repository corpus lifecycle only; current does not assert hosted readiness.

Available options:

current,

stale,

provisional,

indexing,

pending,

failed,

not_found,

unresolvable

indexing_ref

string | null

required

Source-owned opaque listing preparation/progress reference; null when unavailable. Context only, not a search_ref or an advertised REST progress route.

package

object

required

Required resolved package identity and version.

Show child attributes

page_info

object

required

Current source pagination context, not a stable snapshot.

Show child attributes

pages

object[]

required

Complete atomic page summaries. Empty alone does not prove documentation is ready or absent.

A documentation page summary with its read target. Repository pages include exact repository locators.

Option 1
Option 2

Show child attributes

stale

boolean

required

Hosted documentation freshness only; does not describe repository evidence.

target_resolution

null | object

required

Requested/resolved/served repository provenance; null when unavailable.

Show child attributes

⌘I

GET /v1/packages/npm/express/docs HTTP/1.1
Host: api.githits.dev
Authorization: Bearer <token>

{
  "code_index_state": "current",
  "indexing_ref": null,
  "package": {
    "name": "example",
    "registry": "npm",
    "version": "1.0.0"
  },
  "page_info": {
    "end_cursor": "Mg==",
    "has_next_page": true,
    "total_count": 3
  },
  "pages": [
    {
      "docs_read_target": "https://docs.example.org/guide?a=1#setup",
      "file_path": null,
      "git_ref": null,
      "id": "page-42",
      "last_updated_at": null,
      "repo_url": null,
      "requested_ref": null,
      "source_kind": "crawled",
      "source_url": "https://docs.example.org/guide?a=1#setup",
      "title": "Getting started"
    },
    {
      "docs_read_target": "opaque-repo-snapshot-id",
      "file_path": "README.md",
      "git_ref": "0123456789abcdef0123456789abcdef01234567",
      "id": "opaque-repo-snapshot-id",
      "last_updated_at": null,
      "repo_url": "https://github.com/example/project",
      "requested_ref": "main",
      "source_kind": "repo",
      "source_url": null,
      "title": "README"
    }
  ],
  "stale": false,
  "target_resolution": {
    "freshness": "current",
    "freshness_reason": "exact_current",
    "indexing_ref": null,
    "requested": {
      "commit_sha": null,
      "git_ref": null,
      "kind": "package_omitted_version",
      "name": "example",
      "registry": "npm",
      "repo_url": null,
      "version": null
    },
    "resolved_requested": {
      "commit_sha": "0123456789abcdef0123456789abcdef01234567",
      "git_ref": "0123456789abcdef0123456789abcdef01234567",
      "kind": null,
      "name": "example",
      "registry": "npm",
      "repo_url": "https://github.com/example/project",
      "version": "1.0.0"
    },
    "served": {
      "commit_sha": "0123456789abcdef0123456789abcdef01234567",
      "git_ref": "0123456789abcdef0123456789abcdef01234567",
      "kind": null,
      "name": "example",
      "registry": "npm",
      "repo_url": "https://github.com/example/project",
      "version": "1.0.0"
    }
  }
}

Get started

v1 reference

List package documentation pages

Authorizations

Headers

Path Parameters

Query Parameters

Response