String docs
Site integrations

GitHub

GitHub users' public profiles with their linked social accounts and profile README, the repositories a user starred and when, a user's recent public activity and the issues and pull requests they commented on, and a search for accounts by the name on the profile.

Call these actions with your String API key; see Authentication. Every call answers with the envelope described in Responses & errors, whose data holds the rows below.

  • Site: github
  • Version: 1.0.0
  • Reads from: github.com
ActionDescriptionListed price
profileRead GitHub users' public profiles: name, bio, company, location, website, public email, X username, follower and repository counts, account age, the social accounts linked on the profile (LinkedIn, Mastodon, Bluesky and others, each with its service), and the profile README. Up to 25 users per call.Billed per request at your plan's rates
starredList the repositories a GitHub user starred, most recent first, with when they starred each: the repository's name, owner, description, website, language, topics, license, star and fork counts and last push. 100 stars per page, up to 50 pages.Billed per request at your plan's rates
activityRead a GitHub user's public activity: their activity feed for the last 90 days (issue and pull request comments with their text, issues they opened with their text, pull requests they opened or merged, releases with their notes, pushes with their branch and head commit, stars, forks, new branches and repositories) and, further back, the issues and pull requests anywhere on GitHub they commented on, with title, state and who opened each.Billed per request at your plan's rates
user-searchFind GitHub accounts by the name on their profile, matched as a phrase, optionally only those whose location contains a place. Each row is one account's login, id, link, avatar and rank; the profile action reads the rest. Up to 100 accounts.Billed per request at your plan's rates

profile

Read GitHub users' public profiles: name, bio, company, location, website, public email, X username, follower and repository counts, account age, the social accounts linked on the profile (LinkedIn, Mastodon, Bluesky and others, each with its service), and the profile README. Up to 25 users per call.

POST https://request.usestring.ai/v1/integrations/github/profile

Input

Unknown fields are rejected.

FieldTypeDescription
itemsstring[]Required. GitHub logins, @logins or profile URLs such as https://github.com/torvalds. 1 to 25 entries.

Output

data is an array of rows, one per result. Each row has:

FieldTypeDescription
loginstringThe account's login, as GitHub capitalises it.
idintegerGitHub's numeric account id, which survives a login change.
urlstringThe profile on github.com.
typestringUser or Organization.
namestring | nullThe display name on the profile.
biostring | null—
companystring | nullThe company field as the user typed it, such as @github.
locationstring | nullThe location field as the user typed it.
blogstring | nullThe website field as the user typed it, often without a scheme.
emailstring | nullThe email the user chose to show on their profile; null when they show none.
twitterUsernamestring | nullThe X (Twitter) username field.
hireableboolean | nullTrue when the user marked themselves available for hire.
avatarUrlstring—
followersinteger—
followinginteger—
publicReposinteger—
publicGistsinteger—
createdAtstringWhen the account was created, ISO 8601 in UTC.
updatedAtstringWhen the profile last changed, ISO 8601 in UTC.
socialAccountsobject[]The social accounts the user linked on their profile, in their order, deduped by URL.
socialAccounts[].servicestringGitHub's name for the service, such as twitter, linkedin, mastodon, bluesky, youtube or generic.
socialAccounts[].urlstring—
readmestring | nullThe profile README as Markdown: README.md of the user's <login>/<login> repository; null when there is none.
readmeUrlstring | nullThe profile README on github.com.

Example

curl https://request.usestring.ai/v1/integrations/github/profile \
  -H "Authorization: Bearer $STRING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "items": ["simonw"]
  }'

data starts with these rows:

[
  {
    "login": "simonw",
    "id": 9599,
    "url": "https://github.com/simonw",
    "type": "User",
    "name": "Simon Willison",
    "bio": null,
    "company": "Datasette",
    "location": "Half Moon Bay, California",
    "blog": "https://simonwillison.net/",
    "email": null,
    "twitterUsername": "simonw",
    "hireable": null,
    "avatarUrl": "https://avatars.githubusercontent.com/u/9599?v=4",
    "followers": 17788,
    "following": 141,
    "publicRepos": 1000,
    "publicGists": 335,
    "createdAt": "2008-05-07T17:22:14Z",
    "updatedAt": "2026-10-27T17:59:04Z",
    "socialAccounts": [
      {
        "service": "twitter",
        "url": "https://twitter.com/simonw"
      },
      {
        "service": "mastodon",
        "url": "https://fedi.simonwillison.net/@simon"
      },
      {
        "service": "bluesky",
        "url": "https://bsky.app/profile/simonwillison.net"
      }
    ],
    "readme": "Currently working on [Datasette](https://datasette.io/), [LLM](https://llm.datasette.io/) and associated projects. Read [my blog](https://simonwillison.net/), subscribe to [my newsletter](https://simonw.substack.com/), follow me <a href=\"ht…",
    "readmeUrl": "https://github.com/simonw/simonw/blob/main/README.md"
  }
]

Requests and billing

  • Requests: 3–6 Web Access requests per entry in items.
  • Billing: passthrough. Each request the action makes bills at its own rate on your plan; there is no separate charge for the action. See Pricing.

starred

List the repositories a GitHub user starred, most recent first, with when they starred each: the repository's name, owner, description, website, language, topics, license, star and fork counts and last push. 100 stars per page, up to 50 pages.

POST https://request.usestring.ai/v1/integrations/github/starred

Input

Unknown fields are rejected.

FieldTypeDescription
userstringRequired. A GitHub login, @login or profile URL. At least 1 character.
pagesintegerHow many pages of 100 stars to read, newest first, 1 to 50. Defaults to 1. From 1 to 50.

Output

data is an array of rows, one per result. Each row has:

FieldTypeDescription
starredAtstringWhen the user starred it, ISO 8601 in UTC.
fullNamestringowner/name.
ownerstringThe owning user's or organization's login.
namestring—
urlstringThe repository on github.com.
descriptionstring | null—
homepagestring | nullThe website the repository names.
languagestring | nullIts main language, as GitHub detects it.
topicsstring[]The topics its owner tagged it with.
licensestring | nullThe SPDX id of its license, such as MIT.
starsintegerIts star count.
forksinteger—
isForkboolean—
isArchivedboolean—
createdAtstringWhen the repository was created, ISO 8601 in UTC.
pushedAtstring | nullIts last push, ISO 8601 in UTC.

Example

curl https://request.usestring.ai/v1/integrations/github/starred \
  -H "Authorization: Bearer $STRING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "user": "simonw",
    "pages": 2
  }'

data starts with these rows:

[
  {
    "starredAt": "2026-11-14T16:47:04Z",
    "fullName": "lexifina/global-law",
    "owner": "lexifina",
    "name": "global-law",
    "url": "https://github.com/lexifina/global-law",
    "description": "The world's law in git: any provision, any country, any date, and the law that wrote each word.",
    "homepage": "https://lexifina.com",
    "language": "HTML",
    "topics": ["git", "law", "legal-tech", "legislation", "mcp", "open-data"],
    "license": null,
    "stars": 2002,
    "forks": 188,
    "isFork": false,
    "isArchived": false,
    "createdAt": "2026-10-28T13:34:16Z",
    "pushedAt": "2026-11-14T20:52:21Z"
  }
]

Requests and billing

  • Requests: 1–2 Web Access requests per result page.
  • Billing: passthrough. Each request the action makes bills at its own rate on your plan; there is no separate charge for the action. See Pricing.

activity

Read a GitHub user's public activity: their activity feed for the last 90 days (issue and pull request comments with their text, issues they opened with their text, pull requests they opened or merged, releases with their notes, pushes with their branch and head commit, stars, forks, new branches and repositories) and, further back, the issues and pull requests anywhere on GitHub they commented on, with title, state and who opened each.

POST https://request.usestring.ai/v1/integrations/github/activity

Input

Unknown fields are rejected.

FieldTypeDescription
userstringRequired. A GitHub login, @login or profile URL. At least 1 character.
eventPagesintegerPages of 100 public events to read, newest first, 1 to 3. GitHub keeps 90 days and 300 events. Defaults to 1. From 1 to 3.
commentPagesintegerPages of 100 issues and pull requests the user commented on to read, most recently updated first, 1 to 10. Defaults to 1. From 1 to 10.

Output

data is an array of rows, one per result. Each row has:

FieldTypeDescription
sourcestringevent for an entry in the user's public activity feed; commented for an issue or pull request the user commented on, found through search.
idstringThe event's id, or the issue's or pull request's numeric id.
typestringThe event type, such as PushEvent, IssueCommentEvent, PullRequestEvent, IssuesEvent, WatchEvent, CreateEvent or ReleaseEvent; issue or pull_request for a commented row.
actionstring | nullWhat the event did, such as opened, closed or created.
createdAtstringWhen the event happened, or when the issue or pull request was opened, ISO 8601 in UTC.
updatedAtstring | nullWhen a commented issue or pull request last changed, ISO 8601 in UTC.
repostringThe repository, owner/name.
urlstringThe comment, issue, pull request, release, commit or repository on github.com.
titlestring | nullThe issue, pull request or release title; null for a pull request event, whose payload GitHub no longer fills.
bodystring | nullThe user's own text: their comment or review, the issue they opened, or their release notes.
refstring | nullThe branch or tag a push, create or delete event names.
statestring | nullopen or closed, for a commented issue or pull request.
issueOwnerstring | nullWho opened a commented issue or pull request.

Example

curl https://request.usestring.ai/v1/integrations/github/activity \
  -H "Authorization: Bearer $STRING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "user": "simonw",
    "eventPages": 1,
    "commentPages": 1
  }'

data starts with these rows:

[
  {
    "source": "event",
    "id": "27166071739",
    "type": "PushEvent",
    "action": null,
    "createdAt": "2026-11-12T22:53:44Z",
    "updatedAt": null,
    "repo": "simonw/llm-gemini",
    "url": "https://github.com/simonw/llm-gemini/commit/5ad52aff16dfb285ad00b2ef44102b77b2cd7751",
    "title": null,
    "body": null,
    "ref": "main",
    "state": null,
    "issueOwner": null
  },
  {
    "source": "event",
    "id": "27166034915",
    "type": "CreateEvent",
    "action": null,
    "createdAt": "2026-11-13T17:33:04Z",
    "updatedAt": null,
    "repo": "simonw/llm-apple-foundation",
    "url": "https://github.com/simonw/llm-apple-foundation",
    "title": null,
    "body": null,
    "ref": "image-attachments",
    "state": null,
    "issueOwner": null
  },
  {
    "source": "event",
    "id": "20137322053",
    "type": "PullRequestEvent",
    "action": "merged",
    "createdAt": "2026-11-14T20:13:53Z",
    "updatedAt": null,
    "repo": "simonw/datasette-lite",
    "url": "https://github.com/simonw/datasette-lite/pull/97",
    "title": null,
    "body": null,
    "ref": null,
    "state": null,
    "issueOwner": null
  }
]

Requests and billing

  • Requests: 2–26 Web Access requests per call.
  • Billing: passthrough. Each request the action makes bills at its own rate on your plan; there is no separate charge for the action. See Pricing.

Find GitHub accounts by the name on their profile, matched as a phrase, optionally only those whose location contains a place. Each row is one account's login, id, link, avatar and rank; the profile action reads the rest. Up to 100 accounts.

POST https://request.usestring.ai/v1/integrations/github/user-search

Input

Unknown fields are rejected.

FieldTypeDescription
namestringRequired. The person's name as it would appear on their profile, such as Simon Willison. Matched as a phrase against profile names. At least 1 character. At most 100 characters.
locationstringOnly accounts whose location field contains this, such as London. At most 100 characters.
limitintegerThe most accounts to return, 1 to 100. Defaults to 30. From 1 to 100.

Output

data is an array of rows, one per result. Each row has:

FieldTypeDescription
loginstring—
idintegerGitHub's numeric account id.
urlstringThe profile on github.com.
typestringUser or Organization.
avatarUrlstring—
scorenumberGitHub's relevance score for the match.
positionintegerThe account's place in GitHub's ranking, from 1.

Example

curl https://request.usestring.ai/v1/integrations/github/user-search \
  -H "Authorization: Bearer $STRING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Simon Willison",
    "limit": 10
  }'

data starts with these rows:

[
  {
    "login": "simonw",
    "id": 9599,
    "url": "https://github.com/simonw",
    "type": "User",
    "avatarUrl": "https://avatars.githubusercontent.com/u/9599?v=4",
    "score": 1,
    "position": 1
  }
]

Requests and billing

  • Requests: 1–2 Web Access requests per call.
  • Billing: passthrough. Each request the action makes bills at its own rate on your plan; there is no separate charge for the action. See Pricing.