---
title: "GitHub API: Repository Readme | Perceptlayer"
description: "Repository Readme from GitHub as JSON. 1 credit per successful call."
url: https://perceptlayer.com/apis/github/repository-readme
---

[APIs](https://perceptlayer.com/apis) / [GitHub](https://perceptlayer.com/apis/github) / Repository Readme

# GitHub: Repository Readme

Repository Readme from GitHub as JSON. 1 credit per successful call.

GET `/v1/github/repository-readme`

## Parameters

Send parameters in the query string.

| Parameter | Type | Required | Allowed values |
| --- | --- | --- | --- |
| `owner` | string | Required | Up to 39 characters |
| `repo` | string | Required | Up to 100 characters |
| `ref` | string | Optional | Up to 255 characters |

## Example request

cURL shell 

```
curl "https://api.perceptlayer.com/v1/github/repository-readme?owner=laravel&repo=framework" \
  -H "X-API-Key: $API_KEY"
```

[Run this endpoint in the playground](https://perceptlayer.com/apis/github?try=repository-readme#playground) with your own parameters. 1 credit per successful call; failed calls are free.