# OpenSea Collection API Documentation

<p><strong>OpenSea Collection API Documentation</strong> Open one collection by slug for its floor price, top offer and full stats: total and unique supply, owners, sales, listed items and volume with one hour, one day, seven day and thirty day windows. Prices are numbers with a token. Every failed request costs no credit. Cost: 1 credit per successful request. Scrappa is an independent service and is not affiliated with or endorsed by OpenSea.</p>

- **Documentation:** [https://scrappa.co/docs/opensea-api/opensea_collection](https://scrappa.co/docs/opensea-api/opensea_collection)
- **API group:** OpenSea API
- **Endpoint:** `GET https://scrappa.co/api/opensea/collection`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `slug` | string | Yes | Collection slug, e.g. courtyard-nft. Required. |

## Example response

```json
{
    "data": {
        "collection": {
            "name": "Courtyard.io",
            "slug": "courtyard-nft",
            "stats": {
                "sales": 3323503,
                "volume": {
                    "usd": 153683917.72
                },
                "owner_count": 139868,
                "total_supply": 432143,
                "listed_item_count": 31942
            },
            "floor_price": {
                "usd": 4.8,
                "token": {
                    "symbol": "USDC"
                }
            }
        }
    },
    "meta": {
        "source": "opensea",
        "credits": 1,
        "billable": true,
        "endpoint_family": "gql_web"
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | The slug is missing or invalid. This response is not billable. |
| 502 | Bad Gateway | The public data is temporarily unavailable. This response is not billable. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)
