GET/repos/{owner}/{repo}/stargazers/history

Get repository star history

Returns repository stars grouped by calendar weeks, most recent first. Pages move backward toward the repository's creation week, and weeks within a page are ordered newest to oldest, so concatenating pages produces one continuous series. Weeks without stars contain zero counts. Week and day boundaries are not guaranteed to align with UTC. The days array contains the number of stars created on each day of the week, starting on Sunday.

RetriesRetries up to 2×, 500ms backoff, 30s timeout.

4 parameters

ownerstringrequired

The account owner of the repository. The name is not case sensitive.

repostringrequired

The name of the repository without the `.git` extension. The name is not case sensitive.

per_pageintegeroptional

The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."

Default:30

pageintegeroptional

The page number of the results to fetch (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."

Default:1

2 status codes

200Repository star history

daysarray<integer>required

The number of stars created on each day of the week, starting on Sunday.

totalintegerrequired

The number of stars created during the week.

weekintegerrequired

The start of the week, given as a Unix timestamp.

422Validation failed, or the endpoint has been spammed.

messagestringrequired

documentation_urlstringrequired

errorsarray<object>optional

Error handling

A 422 is returned: Validation failed, or the endpoint has been spammed.

import { Client } from "octri-github";

const client = new Client({
  baseUrl: "https://api.github.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.history.list({
  owner: "octocat",
  repo: "hello-world",
  perPage: 20,
  page: 1,
});

[
  {
    "week": 1754784000,
    "total": 19,
    "days": [
      0,
      12,
      7,
      0,
      0,
      0,
      0
    ]
  }
]

Was this helpful?

Request

Response

Errors