> **For coding agents and LLMs:** This is one Social Fetch marketing page (markdown export). For API orientation start with [`/llms.txt`](https://www.socialfetch.dev/llms.txt); for auth and crawl rules use [`/agents.txt`](https://www.socialfetch.dev/agents.txt); for every operation use [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt).

## This page

- **On-site (HTML):** <https://www.socialfetch.dev/platforms/hugging-face/repos-repotype-owner-name-readme>
- **Markdown (.mdx) URL:** <https://www.socialfetch.dev/platforms/hugging-face/repos-repotype-owner-name-readme.mdx>

---

# Hugging Face README API

The full repository card as markdown, with the YAML header intact and the commit it came from.

`GET /v1/hugging-face/repos/{repoType}/{owner}/{name}/readme` returns `repo` and `readme`. `readme.markdown` is the file as written, including the YAML header the platform keeps metadata in, and `readme.sizeBytes` plus `readme.revision` describe the returned file.

`repoType` is `models`, `datasets` or `spaces`, and `revision` selects a branch, tag or commit. A repository with no README is `lookupStatus: found` with `readme: null`. A repository that does not exist is `not_found`.

## Request

- **Endpoint:** `GET /v1/hugging-face/repos/{repoType}/{owner}/{name}/readme`
- **Credits:** 1 credit
Failed requests are free
- **Input:** by repository
- **Full reference:** [docs](https://www.socialfetch.dev/docs/api/v1/hugging-face/repos/repotype/owner/name/readme/get)
- **Platform page:** [/platforms/hugging-face](https://www.socialfetch.dev/platforms/hugging-face)

## FAQ

### Does this include the YAML header?

Yes. readme.markdown keeps the header, so the licence, language and dataset fields are there exactly as the author wrote them.

### What does a missing README look like?

lookupStatus is found and readme is null. That is different from a missing repository, which returns lookupStatus not_found.

### Which repository types work?

repoType accepts models, datasets and spaces.

### How much does a README lookup cost?

Pricing is documented on the operation in the API registry (shown on this page). Confirm on every response with meta.creditsCharged: that field is the billing source of truth.