---
title: "Contents"
method: GET
path: "/v1/github/repo/contents"
tags: ["GitHub"]
---

# Contents

`GET /v1/github/repo/contents`

## Request

- Base URL: `https://api.scrapeatlas.com`
- URL: `https://api.scrapeatlas.com/v1/github/repo/contents`
- Auth: API key in header `x-api-key`

Read repository directory entries or a file with its path, type, size, SHA, encoded content and source links; select a branch, tag or commit with ref. Use view=readme for the repository README as text, or view=profile-readme with a handle or profile URL for a profile README. Each successful request costs 1 account credit, including partial results. Failed requests cost 0 credits.

## Query parameters

- `url` string
- `path` string
- `ref` string
- `handle` string
- `view` 'contents' | 'readme' | 'profile-readme'

## Response `200`

Inspect the response status and failure or coverage fields.

- union
  - object
    - `platform` 'github'
    - `endpoint` string
    - `success` true, required
    - `status` 'success' | 'partial', required
    - `requestId` string, uuid, required
    - `sourceUrl` string, uri, required
    - `fetchedAt` string, date-time, required
    - `coverage` object, required
      - `source` 'public_api' | 'public_html', required
      - `complete` boolean, required
      - `warnings` string[], required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
    - `data` object, required
      - `type` 'directory' | 'file', required
      - `items` object[], nullable, required
        - `name` string, required
        - `path` string, required
        - `sha` string, required
        - `size` integer, required
        - `type` 'file' | 'dir' | 'symlink' | 'submodule', required
        - `html_url` string, uri, nullable, required
        - `download_url` string, uri, nullable, required
        - `git_url` string, uri, nullable, required
        - `encoding` string
        - `content` string
        - `target` string
        - `submodule_git_url` string
      - `file` object, nullable, required
        - `name` string, required
        - `path` string, required
        - `sha` string, required
        - `size` integer, required
        - `type` 'file' | 'dir' | 'symlink' | 'submodule', required
        - `html_url` string, uri, nullable, required
        - `download_url` string, uri, nullable, required
        - `git_url` string, uri, nullable, required
        - `encoding` string
        - `content` string
        - `target` string
        - `submodule_git_url` string
      - `returnedCount` integer, required
      - `truncated` boolean, required
  - object
    - `success` false, required
    - `status` 'failed' | 'challenged', required
    - `requestId` string, uuid, required
    - `failure` object, required
      - `code` 'invalid_request' | 'unauthorized' | 'not_found' | 'upstream_challenged' | 'upstream_rate_limited' | 'upstream_error' | 'unsupported_page' | 'response_too_large' | 'unsafe_redirect' | 'request_limit' | 'timeout' | 'busy' | 'payload_too_complex' | 'upstream_pending', required
      - `message` string, required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
  - object
    - `platform` 'github'
    - `endpoint` string
    - `success` true, required
    - `status` 'success' | 'partial', required
    - `requestId` string, uuid, required
    - `sourceUrl` string, uri, required
    - `fetchedAt` string, date-time, required
    - `coverage` object, required
      - `source` 'public_api' | 'public_html', required
      - `complete` boolean, required
      - `warnings` string[], required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
    - `data` object, required
      - `content` object, required
        - `text` string, required
      - `url` string, uri, required
      - `post` object
        - `id` string, required
        - `url` string, uri, nullable, required
        - `content` object, required
          - `text` string, nullable, required
          - `media_urls` string[], nullable, required
          - `thumbnail_url` string, nullable, required
          - `duration_seconds` number, nullable, required
        - `author` object, required
          - `username` string, nullable, required
          - `display_name` string, nullable, required
          - `avatar_url` string, uri, nullable, required
          - `verified` boolean, nullable, required
        - `engagement` object, required
          - `views` integer, nullable, required
          - `likes` integer, nullable, required
          - `comments` integer, nullable, required
          - `shares` integer, nullable, required
          - `saves` integer, nullable, required
        - `flags` object, required
          - `nsfw` boolean, nullable, required
          - `spoiler` boolean, nullable, required
          - `pinned` boolean, nullable, required
          - `deleted` boolean, required
        - `published_at` string, nullable, required
        - `ext` object

## Other responses

- `400`: Request could not complete; inspect error or failure.code.
- `401`: Request could not complete; inspect error or failure.code.
- `402`: Request could not complete; inspect error or failure.code.
- `403`: Request could not complete; inspect error or failure.code.
- `404`: Request could not complete; inspect error or failure.code.
- `408`: Request could not complete; inspect error or failure.code.
- `413`: Request could not complete; inspect error or failure.code.
- `429`: Request could not complete; inspect error or failure.code.
- `500`: Request could not complete; inspect error or failure.code.
- `502`: Request could not complete; inspect error or failure.code.
- `503`: Request could not complete; inspect error or failure.code.
- `504`: Request could not complete; inspect error or failure.code.

---

[API](https://skmtc.dev/scrapeatlas/apis/scrapeatlas-api.md) · [All operations](https://skmtc.dev/scrapeatlas/apis/scrapeatlas-api/llms.txt) · [OpenAPI document](https://skmtc.dev/scrapeatlas/apis/scrapeatlas-api/revisions/9ba049316894?raw)