github

List a repository's issues (and PRs)

Returns issues for the repository under data.items[]. NOTE: GitHub treats pull requests as issues for this endpoint: every PR also appears here, distinguishable by the presence of a pull_request field on the item. Filter by state, comma-separated labels, sort by created/updated/comments, and paginate with per_page/page. since accepts an ISO 8601 timestamp.

get/github/repo/issues

Request

  • Base URL: https://www.socialcrawl.dev/v1
  • URL: https://www.socialcrawl.dev/v1/github/repo/issues
  • Auth: API key in header x-api-key

Query parameters

urlstring required

GitHub repo URL: https://github.com/{owner}/{repo}.

type'issue' | 'pr' | 'all'

Filter the unified issues+PRs list: issue returns only issues, pr returns only pull requests, all (default) returns both. Each item also carries post.ext.type (issue/pull_request).

state'open' | 'closed' | 'all'

open, closed, or all. Defaults to open.

labelsstring

Comma-separated label names (e.g. bug,help wanted).

sort'created' | 'updated' | 'comments'

created, updated, or comments. Defaults to created.

direction'asc' | 'desc'

asc or desc. Defaults to desc.

sincestring

Only issues updated at or after this ISO 8601 timestamp.

per_pageinteger

Issues per page (1-100). Defaults to 30. Native upstream page-size param. Send the universal limit instead: the API maps it to this name for you.

pageinteger

1-indexed page number. Native upstream cursor param. Send the universal cursor instead: the API maps it to this name for you.

cursorstring

Universal pagination cursor. Send pagination.next_cursor from the previous response back verbatim: the API maps it to this endpoint's native page (page style). You never construct, decode, or look up a cursor. Omit it for page 1.

limitinteger

Universal page size. The API maps it to this endpoint's native per_page.

Headers

Cache-Controlstring

Send no-cache to bypass the response cache and force a live fetch. Billed at the normal endpoint cost; the fresh result is written back to cache for the next caller. Only the no-cache directive triggers this. See the Response Schema guide for details.

Idempotency-Keystring

Optional UUID that makes the request safely retriable. The key is reserved atomically per account before billing. A concurrent retry receives 409 IDEMPOTENCY_IN_PROGRESS with a Retry-After of 1 second while the original is young, growing to a quarter of the time it has been running (at most 30); a crashed reservation expires after 5 minutes. A replay keeps the cached payload immutable except for billing metadata: credits_used becomes 0, idempotent_replay becomes true, and credits_remaining is refreshed to the current balance. A known current balance appears in both the body and X-Credits-Remaining header; no balance row resolves to 0. On a transient lookup failure, body credits_remaining is null and X-Credits-Remaining is omitted. Completed outcomes expire after 24 hours. If the claim store is unavailable, the request fails closed before billing. GET endpoints do not combine idempotent replay with Server-Sent Events: use Accept: application/json when sending this header. The unsupported key-plus-SSE combination is rejected before billing.

Response

Successful response

successboolean required

Whether the request succeeded

platformstring required

Platform name

endpointstring required

API endpoint path

credits_usedinteger required

Number of credits consumed

credits_remaininginteger nullable required

Current account balance, or null when this response could not establish one. Free cache hits always return null because they do not establish an authoritative post-request balance. An idempotency replay also returns null when its current-balance lookup fails. It is never a fabricated zero, so a zero here means the account really is empty. The authoritative reading is the one on a billed response, which comes straight from the deduction.

request_idstring required

Unique request identifier for support

cachedboolean required

Whether the response was served from cache

idempotent_replayboolean

True only when this response is an idempotency replay

Example response

{
  "success": true,
  "platform": "github",
  "endpoint": "/v1/github/repo/issues",
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "req-abc123",
  "idempotent_replay": true,
  "meta": {
    "hint": {
      "code": "search_multi",
      "message": "You searched \"matcha\" on 3 platforms one call at a time; /v1/search/multi returns each platform's own search rows in one call at the same price per platform, and a platform with no rows is not charged.",
      "method": "GET",
      "path": "/v1/search/multi?query=matcha&platforms=instagram,tiktok,youtube"
    }
  },
  "pagination": {
    "next_cursor": "sc.eyJ2IjoyLCJjIjoiMiIsInAiOiJwYWdlIn0",
    "has_more": true,
    "page_size": 30,
    "stopped_at": "known_id"
  }
}

Changes

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