# GitBanners API

> Keyless, read-only operations of GitBanners: JSON under https://gitbanners.com/api/v1 and banner images at the site root. Parent index: https://gitbanners.com/llms.txt

## Operations

Each link is a request that works as written.

- [getOptions](https://gitbanners.com/api/v1/options): `GET /api/v1/options`. List presets, themes, sizes and parameters
- [search](https://gitbanners.com/api/v1/search?q=verc): `GET /api/v1/search`. Search accounts and repositories by prefix
- [getBanner](https://gitbanners.com/api/v1/banner?target=vercel/next.js&preset=contributors&theme=dracula): `GET /api/v1/banner`. Describe one banner: URLs, embed code, size
- [getOwner](https://gitbanners.com/api/v1/owners/vercel): `GET /api/v1/owners/{login}`. Get a user or an organization
- [getRepository](https://gitbanners.com/api/v1/repos/vercel/next.js): `GET /api/v1/repos/{owner}/{repo}`. Get a repository
- [getIndex](https://gitbanners.com/api/v1): `GET /api/v1`. Get the API index
- [getApiRoot](https://gitbanners.com/api): `GET /api`. Get the API root
- [getOwnerImage](https://gitbanners.com/markeljan.svg): `GET /{owner}.{format}`. Draw the banner of a user or an organization
- [getRepositoryImage](https://gitbanners.com/vercel/next.js.png): `GET /{owner}/{repo}.{format}`. Draw the banner of a repository, or a profile preset

## Reference

- [OpenAPI description](https://gitbanners.com/openapi.json)
- [API docs](https://gitbanners.com/docs#rest-api): parameters, errors, rate limits
- [API catalog (RFC 9727)](https://gitbanners.com/.well-known/api-catalog)