GitHub Repo Readme API
API 한 번의 호출로 GitHub Repo Readme 데이터를 받아 가세요. Returns the repository's README in raw form (the file contents, not base64-wrapped). The fetcher sets `Accept: application/vnd.github.raw+json` so the response body is the actual file. Useful for content discovery and AI-grounding workflows.
2026년 8월 업데이트SocialCrawl 팀이 직접 관리해요
GitHub 저장소의 README를 파일 원문 그대로 반환합니다. 바로 읽어도 되고 모델에 그대로 넣어도 됩니다.
repo가 주는 요약 필드 대신 프로젝트가 직접 쓴 설명 전문이 필요할 때 사용하세요.
48개 플랫폼을 병렬로 검색합니다
Repo Readme API로 무엇을 할 수 있을까요
Repo Readme 엔드포인트가 통합 스키마와 계산 필드를 담은 GitHub 데이터를 한 번의 요청으로 보내드려요. 스크래핑 인프라를 직접 만들거나 유지할 필요가 없어요.
요청 예시
curl -H "x-api-key: YOUR_API_KEY" \
"https://www.socialcrawl.dev/v1/github/repo/readme?url=https%3A%2F%2Fgithub.com%2Foctocat%2FHello-World"import requests
response = requests.get(
"https://www.socialcrawl.dev/v1/github/repo/readme",
params={
'url': 'https://github.com/octocat/Hello-World',
},
headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()const response = await fetch(
"https://www.socialcrawl.dev/v1/github/repo/readme?url=https%3A%2F%2Fgithub.com%2Foctocat%2FHello-World",
{
headers: { "x-api-key": "YOUR_API_KEY" },
},
);
const data = await response.json();파라미터
| 파라미터 | 필수 | 설명 |
|---|---|---|
| url | 예 | GitHub repo URL — `https://github.com/{owner}/{repo}`. |
GitHub Repo Readme API는 무엇을 돌려주나요
모든 응답은 하나의 통합 스키마를 따라요. 크레딧을 쓰기 전에 어떤 필드가 돌아오는지, 실제 응답 본문 그대로 확인해 보세요.
응답 예시 보기
{
"success": true,
"platform": "youtube",
"endpoint": "/v1/youtube/video",
"data": {
"post": {
"id": "dQw4w9WgXcQ",
"content": {
"text": "Rick Astley - Never Gonna Give You Up (Official Video) (4K Remaster)",
"thumbnail_url": "https://i.ytimg.com/vi/dQw4w9WgXcQ/hqdefault.jpg",
"duration_seconds": 214,
"media_urls": "https://www.youtube.com/channel/UCuAXFkgsw1L7xaCfnd5JJOw"
},
"author": {
"username": "UCuAXFkgsw1L7xaCfnd5JJOw",
"display_name": "Rick Astley",
"avatar_url": null,
"verified": null
},
"engagement": {
"views": 1789065639,
"likes": 19216844,
"comments": 2443809,
"shares": null,
"saves": null
},
"published_at": "2009-10-25T06:57:33Z",
"url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
"ext": {
"content_type": "video",
"tags": [
"rick astley",
"Never Gonna Give You Up",
"nggyu",
"never gonna give you up lyrics",
"rick rolled",
"Rick Roll",
"rick astley official",
"rickrolled",
"Fortnite song",
"Fortnite event",
"Fortnite dance",
"fortnite never gonna give you up",
"rick roll",
"rickrolling",
"rick rolling",
"never gonna give you up",
"80s music",
"rick astley new",
"animated video",
"rickroll",
"meme songs",
"never gonna give u up lyrics",
"Rick Astley 2022",
"never gonna let you down",
"animated",
"rick rolls 2022",
"never gonna give you up karaoke"
],
"categoryId": "10",
"categoryTitle": "Music",
"topicCategories": [
"https://en.wikipedia.org/wiki/Electronic_music",
"https://en.wikipedia.org/wiki/Music",
"https://en.wikipedia.org/wiki/Pop_music",
"https://en.wikipedia.org/wiki/Rhythm_and_blues",
"https://en.wikipedia.org/wiki/Soul_music"
],
"duration": "PT3M34S",
"license": "youtube",
"madeForKids": false,
"defaultAudioLanguage": "en",
"hasPaidProductPlacement": false,
"caption": "true",
"description": "The official video for “Never Gonna Give You Up” by Rick Astley. \n\nNever: The Autobiography 📚 OUT NOW! \nFollow this link to get your copy and listen to Rick’s ‘Never’ playlist ❤️ #RickAstleyNever\nhttps://linktr.ee/rickastleynever\n\n“Never Gonna Give You Up” was a global smash on its release in July 1987, topping the charts in 25 countries including Rick’s native UK and the US Billboard Hot 100. It also won the Brit Award for Best single in 1988. Stock Aitken and Waterman wrote and produced the track which was the lead-off single and lead track from Rick’s debut LP “Whenever You Need Somebody”. The album was itself a UK number one and would go on to sell over 15 million copies worldwide.\n\nThe legendary video was directed by Simon West – who later went on to make Hollywood blockbusters such as Con Air, Lara Croft – Tomb Raider and The Expendables 2. The video passed the 1bn YouTube views milestone on 28 July 2021.\n\nSubscribe to the official Rick Astley YouTube channel: https://RickAstley.lnk.to/YTSubID\n\nFollow Rick Astley:\nFacebook: https://RickAstley.lnk.to/FBFollowID \nTwitter: https://RickAstley.lnk.to/TwitterID \nInstagram: https://RickAstley.lnk.to/InstagramID \nWebsite: https://RickAstley.lnk.to/storeID \nTikTok: https://RickAstley.lnk.to/TikTokID\n\nListen to Rick Astley:\nSpotify: https://RickAstley.lnk.to/SpotifyID \nApple Music: https://RickAstley.lnk.to/AppleMusicID \nAmazon Music: https://RickAstley.lnk.to/AmazonMusicID \nDeezer: https://RickAstley.lnk.to/DeezerID \n\nLyrics:\nWe’re no strangers to love\nYou know the rules and so do I\nA full commitment’s what I’m thinking of\nYou wouldn’t get this from any other guy\n\nI just wanna tell you how I’m feeling\nGotta make you understand\n\nNever gonna give you up\nNever gonna let you down\nNever gonna run around and desert you\nNever gonna make you cry\nNever gonna say goodbye\nNever gonna tell a lie and hurt you\n\nWe’ve known each other for so long\nYour heart’s been aching but you’re too shy to say it\nInside we both know what’s been going on\nWe know the game and we’re gonna play it\n\nAnd if you ask me how I’m feeling\nDon’t tell me you’re too blind to see\n\nNever gonna give you up\nNever gonna let you down\nNever gonna run around and desert you\nNever gonna make you cry\nNever gonna say goodbye\nNever gonna tell a lie and hurt you\n\n#RickAstley #NeverGonnaGiveYouUp #WheneverYouNeedSomebody #OfficialMusicVideo",
"default_language": "en"
},
"flags": {
"deleted": false,
"nsfw": null,
"spoiler": null,
"pinned": null
}
},
"computed": {
"engagement_rate": 0.012107,
"language": "en",
"content_category": "entertainment",
"estimated_reach": 2146878767
}
},
"credits_used": 1,
"credits_remaining": 9999,
"request_id": "req-8Kq2ZmR4vT9xLb3P",
"cached": false
}YouTube API에서 가져온 예시예요. 모든 SocialCrawl 엔드포인트가 똑같은 통합 스키마를 돌려주기 때문에, GitHub Repo Readme 응답도 같은 필드로 구성돼요.
GitHub Repo Readme API는 어떻게 동작하나요
API 키와 함께 GET 요청을 보내면, 통합 스키마와 계산 필드를 담은 깔끔한 JSON이 돌아와요.
메서드
GET
응답 형식
JSON
소셜 미디어 데이터를 몇 초 만에 수집하는 방법
개발자를 위한 가장 빠른 소셜 미디어 스크래핑 API. 월간 활성 사용자 100억 명 이상을 포괄하는 48개 플랫폼에서 프로필, 게시물, 댓글, 분석 데이터를 수집하세요.
모든 플랫폼을 하나의 스키마로
동일한 응답 구조로 48개 플랫폼을 조회하세요. 연동은 한 번이면 충분합니다.
단순 수집을 넘어 계산된 필드 제공
엔드포인트가 해당 지표를 지원하고 계산에 필요한 원본 값이 있을 때, 정규화된 레코드에 engagement_rate, estimated_reach, content_category, language를 함께 담아 바로 활용할 수 있습니다.
코드 한 줄 쓰기 전에, 데이터부터
Visual Data Explorer — URL만 붙여넣으면 결과 카드, 정형화된 테이블, CSV 내보내기 기능을 제공합니다.
import requests
response = requests.get(
'https://www.socialcrawl.dev/v1/tiktok/profile',
params={'handle': 'charlidamelio'},
headers={'x-api-key': 'sc_YOUR_API_KEY'}
)
data = response.json(){
"success": true,
"platform": "tiktok",
"data": {
"author": {
"username": "charlidamelio",
"followers": 152400000
},
"engagement": {
"likes": 12400000000,
"engagement_rate": 0.087
},
"metadata": {
"language": "en",
"content_category": "lifestyle"
}
}
}자주 묻는 질문
API, 요금제, 기능에 대한 질문과 답변입니다.
문의하기저장소 README는 어떻게 받아오나요?
README는 Base64인가요, 일반 텍스트인가요?
어떤 README 파일을 반환하나요?
README를 LLM에 넣는 용도로 써도 되나요?
GitHub README API는 요금이 얼마인가요?
AI에게 SocialCrawl을 물어보세요
GitHub Repo Readme 데이터, 가져올 준비 되셨어요?
API 키 받고 60초 안에 GitHub 데이터를 받아 가세요.
