# GitHits API

**Canonical:** https://apis.io/apis/githits-com/githits-com-api/  
**Provider:** GitHits — https://apis.io/providers/githits-com/  
**Documentation:** https://docs.githits.com/api/errors.md

GitHits API is published by [GitHits](https://apis.io/providers/githits-com/) on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

GitHits API as documented publicly: 21 operations. Contract generated from the documentation by API Evangelist (2026-11-10); not the provider's own document.

## Operations (21)

| Method | Path | Summary |
|---|---|---|
| GET | `/` | GET / |
| GET | `/api-reference/v1/experimental/submit-a-lockfile-analysis-job.md` | GET /api-reference/v1/experimental/submit-a-lockfile-analysis-job.md |
| GET | `/api/quickstart.md` | GET /api/quickstart.md |
| GET | `/v1/changelog` | GET /v1/changelog |
| POST | `/v1/code/diff` | Use POST /v1/code/diff for source comparisons. |
| GET | `/v1/experimental/license-reports` | GET /v1/experimental/license-reports |
| POST | `/v1/experimental/license-reports` | Synchronously generate a license report (experimental) |
| GET | `/v1/experimental/license-reports/{id}` | Preview a compact report for a completed analysis |
| POST | `/v1/experimental/licenses` | Synchronously generate a license report (experimental) |
| GET | `/v1/experimental/licenses/{id}` | Legacy read of a license report (schema 1) |
| GET | `/v1/experimental/lockfile-jobs` | GET /v1/experimental/lockfile-jobs |
| POST | `/v1/experimental/lockfile-jobs` | Submit an SBOM, audit or license‑report job |
| POST | `/v1/experimental/research` | POST /v1/experimental/research |
| POST | `/v1/experimental/sbom` | Synchronously generate an SBOM (experimental) |
| POST | `/v1/experimental/targets/resolve` | POST /v1/experimental/targets/resolve |
| POST | `/v1/list` | POST /v1/list |
| GET | `/v1/package-upgrade-reviews` | GET /v1/package-upgrade-reviews |
| POST | `/v1/package-upgrade-reviews` | POST /v1/package-upgrade-reviews |
| GET | `/v1/packages/npm/express` | GET /v1/packages/npm/express |
| GET | `/v1/packages/npm/express/dependencies` | GET /v1/packages/npm/express/dependencies |
| GET | `/v1/read` | Follow an entry’s read action with its exact target and non‑null path |

## Machine-readable artifacts (8)

- **OpenAPI** — https://artifacts.apis.io/githits-com/openapi/_ae-authored/githits-com-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/githits-com/json-schema/githits-com-get-v1-package-upgrade-reviews-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/githits-com/json-schema/githits-com-post-v1-package-upgrade-reviews-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/githits-com/json-schema/githits-com-post-v1-experimental-lockfile-jobs-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/githits-com/json-schema/githits-com-get-v1-packages-npm-express-dependencies-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/githits-com/json-schema/githits-com-get-v1-experimental-license-reports-id-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/githits-com/json-schema/githits-com-post-v1-experimental-sbom-request-schema.json
- **APIsJSON** — https://artifacts.apis.io/githits-com/apis.yml

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/githits-com/githits-com-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/githits-com/.