github

Fetch a repository's README, decoded to UTF-8 text (name...

Fetch a repository's README, decoded to UTF-8 text (name, path, size, content, URL). Optionally pin to a branch/tag/sha via ref. Useful for summarizing or indexing a project. Read-only; no caller key needed.

get/api/github/readme

Request

  • Base URL: https://2s.io
  • URL: https://2s.io/api/github/readme
  • Auth: API key in header PAYMENT-SIGNATURE

Query parameters

ownerstring required

Owner.

repostring required

Repo.

refstring

Ref.

trial1

Try before you buy. Set to 1 for one free real call per endpoint per hour — no wallet or payment needed — to verify the endpoint before paying. Equivalent to sending the "X-2s-Trial: 1" request header. Listed only on operations that offer a trial; the others always answer 402.

Response

(unresolved $ref)

Changes

No recorded changes to this operation across all 1 revision of this API.