# LinkMetadata

> Free link metadata API and preview web component for public URLs.

LinkMetadata extracts titles, descriptions, images, favicons, Open Graph tags, Twitter Card tags, and readable safety tags. The public API is free to use and rate limited to 20 requests per 10 seconds per IP address.

## LLM files

- [Full documentation](https://linkmetadata.com/llms-full.txt): Complete Markdown context for docs, product pages, and API reference.
- [OpenAPI JSON](https://linkmetadata.com/openapi.json): Committed OpenAPI 3.0 schema for the public API.

## Product pages

- [Home](https://linkmetadata.com/index.md): Product overview, API basics, and component basics.
- [Docs index](https://linkmetadata.com/docs.md): Documentation map by Diataxis section.
- [API Reference](https://linkmetadata.com/docs/api-reference.md): Markdown API reference generated from OpenAPI.
- [Terms & Privacy](https://linkmetadata.com/legal.md): Data handling and service terms.

## Documentation

### Tutorials

- [Build your first link preview](https://linkmetadata.com/docs/tutorials/get-started.md): Add the LinkMetadata component to a page and fetch metadata from the API.

### How-to Guides

- [Customize the preview component](https://linkmetadata.com/docs/how-to/customize-the-preview-component.md): Change the card theme, layout, visibility, and styling.
- [Render pre-fetched metadata](https://linkmetadata.com/docs/how-to/render-prefetched-metadata.md): Use data-meta to render cached or server-rendered metadata without another API request.
- [Use LinkMetadata with React](https://linkmetadata.com/docs/how-to/use-with-react.md): Add the preview component to React or fetch metadata for a custom React card.
- [Use LinkMetadata with Vue](https://linkmetadata.com/docs/how-to/use-with-vue.md): Add the preview component to Vue or fetch metadata for a custom Vue card.
- [Use LinkMetadata with Svelte](https://linkmetadata.com/docs/how-to/use-with-svelte.md): Add the preview component to Svelte or fetch metadata for a custom Svelte card.
- [Use LinkMetadata with Astro](https://linkmetadata.com/docs/how-to/use-with-astro.md): Add the preview component to Astro or fetch metadata during Astro rendering.

### Reference

- [Component reference](https://linkmetadata.com/docs/reference/component.md): Attributes, CSS variables, and stable selectors for the preview component.
- [Metadata API reference](https://linkmetadata.com/docs/reference/metadata-response.md): Request parameters, response fields, cache behavior, and errors for the metadata endpoint.

### Explanation

- [How LinkMetadata works](https://linkmetadata.com/docs/explanation/how-linkmetadata-works.md): How metadata extraction, caching, images, and safety tags fit together.
- [Metadata extraction rules](https://linkmetadata.com/docs/explanation/metadata-extraction-rules.md): How LinkMetadata chooses titles, descriptions, URLs, images, favicons, and raw tag maps.
- [Images and CORS](https://linkmetadata.com/docs/explanation/images-and-cors.md): How LinkMetadata analyzes preview images, marks CORS safety, and proxies images for browser cards.
- [Safety tags](https://linkmetadata.com/docs/explanation/safety-tags.md): What safety tags mean, how they are produced, and how to use them in product decisions.