Get contribution streaks

Evaluate current and longest streaks over GitHub’s trailing 365-day contribution calendar.

GET/v1/users/{username}/streak

Path parameters

usernameGitHubUsernamerequired

Responses

200

ContributionStreak

userUserrequired

Show properties

loginGitHubUsernamerequired

urlany<uri>required

avatarUrlany<uri>required

fromIsoDaterequired

toIsoDaterequired

currentStreakintegerrequired

min 0 · max 365

longestStreakintegerrequired

min 0 · max 365

activebooleanrequired

400

InvalidRequestProblem | InvalidCursorProblem

Any of:

InvalidRequestProblem

typestringrequired

titlestringrequired

detailstringrequired

instancestringrequired

statusnumberrequired

Allowed:400

InvalidCursorProblem

typestringrequired

titlestringrequired

detailstringrequired

instancestringrequired

statusnumberrequired

Allowed:400

404

UserNotFoundProblem | LatestCommitNotFoundProblem

Any of:

UserNotFoundProblem

typestringrequired

titlestringrequired

detailstringrequired

instancestringrequired

statusnumberrequired

Allowed:404

LatestCommitNotFoundProblem

typestringrequired

titlestringrequired

detailstringrequired

instancestringrequired

statusnumberrequired

Allowed:404

429

RateLimitedProblem

typestringrequired

titlestringrequired

detailstringrequired

instancestringrequired

statusnumberrequired

Allowed:429

retryAfterSecondsintegerrequired

max 9007199254740991

502

UpstreamFailureProblem

typestringrequired

titlestringrequired

detailstringrequired

instancestringrequired

statusnumberrequired

Allowed:502

503

ServiceUnavailableProblem

typestringrequired

titlestringrequired

detailstringrequired

instancestringrequired

statusnumberrequired

Allowed:503

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Parameters

usernamepath*

Request

curl -X GET 'https://kronik.informati.dev/api/v1/users/string/streak' \
  -H 'Accept: application/json'

const response = await fetch("https://kronik.informati.dev/api/v1/users/string/streak", {
  method: "GET",
  headers: {
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://kronik.informati.dev/api/v1/users/string/streak",
    headers={
        "Accept": "application/json"
    },
)

Response

{
  "user": {
    "login": "string",
    "url": "http://example.com",
    "avatarUrl": "http://example.com"
  },
  "from": "string",
  "to": "string",
  "currentStreak": 0,
  "longestStreak": 0,
  "active": true
}

{
  "type": "string",
  "title": "string",
  "detail": "string",
  "instance": "string",
  "status": 400
}

{
  "type": "string",
  "title": "string",
  "detail": "string",
  "instance": "string",
  "status": 404
}

{
  "type": "string",
  "title": "string",
  "detail": "string",
  "instance": "string",
  "status": 429,
  "retryAfterSeconds": 1
}

{
  "type": "string",
  "title": "string",
  "detail": "string",
  "instance": "string",
  "status": 502
}

{
  "type": "string",
  "title": "string",
  "detail": "string",
  "instance": "string",
  "status": 503
}