OctoCounts API Docs

OctoCounts analyzes public GitHub and GitLab repositories only. It does not request GitHub or GitLab account access, does not support private repositories, and does not accept source-code uploads.

Analyze a Repository

POST https://api.octocounts.com/api/analyze
Content-Type: application/json

{
  "repoUrl": "https://github.com/owner/repo",
  "refName": "main",
  "forceRefresh": false,
  "options": {
    "profile": "default",
    "ignoredDirs": [],
    "ignoredLanguages": [],
    "includeDocs": true,
    "includeTests": true,
    "includeGenerated": true
  }
}

repoUrl supports public github.com repositories and public gitlab.com repositories. refName may be a branch, tag, or commit SHA. If omitted, OctoCounts uses the repository default branch.

Job Status

GET https://api.octocounts.com/api/jobs/:jobId

Jobs return queued, running, completed, or failed. Completed jobs include reportId.

Report

GET https://api.octocounts.com/api/reports/:reportId

Reports include repository metadata, pinned commit SHA, tokei version, analysis key, active analysis options, language rows, and totals for files, lines, code, comments, and blanks.

Badges

GET https://api.octocounts.com/badge/:owner/:repo
GET https://api.octocounts.com/badge/:owner/:repo/branch/:branch
GET https://api.octocounts.com/badge/:owner/:repo/tag/:tag
GET https://api.octocounts.com/badge/:owner/:repo/commit/:sha

Badge query parameters:

• type=code, lines, files, comments, languages, top-language, or ratio
• lang=Rust for a single-language code-line badge

Shareable Web URLs

https://octocounts.com/github/:owner/:repo
https://octocounts.com/github/:owner/:repo/tree/:ref
https://octocounts.com/github/:owner/:repo/commit/:sha
https://octocounts.com/compare?left=...&right=...&leftRef=...&rightRef=...
https://octocounts.com/diff?repo=...&base=...&head=...

Back to OctoCounts