Rebrickable API v3

https://rebrickable.com/api/v3/
Admin
Rebrickable API v3 is a REST API providing access to comprehensive LEGO catalog data including sets,...
Tokens:2,808
Snippets:25
Trust Score:9.3
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Throttling Response Example

Source: https://rebrickable.com/api/v3/docs

Example JSON response returned when a request is throttled (HTTP 429). The response indicates when the request can be retried.

```json
{ "detail": "Request was throttled. Expected available in 2 seconds." }
```

--------------------------------

### GET /lego/colors/

Source: https://rebrickable.com/api/v3/docs

Authentication for all API calls can be done via an Authorization header or a key parameter. Lists support pagination, page size, and ordering parameters.

```APIDOC
## GET /lego/colors/

### Description
Retrieves a list of LEGO colors from the catalog.

### Method
GET

### Endpoint
https://rebrickable.com/api/v3/lego/colors/

### Parameters
#### Query Parameters
- **key** (string) - Required - Your API key.
- **page** (integer) - Optional - Page number for paginated results (base 1).
- **page_size** (integer) - Optional - Number of results per page (default 100, max 1000).
- **ordering** (string) - Optional - Field(s) to order by, comma-separated for nested ordering, prefix with '-' for reverse order.

### Request Example
```
curl --header 'Authorization: key b4e0697ce3d5cf21af1088e9bd238dd' https://rebrickable.com/api/v3/lego/colors/
```

### Response
#### Success Response (200)
- **next** (string) - URL for the next page of results.
- **previous** (string) - URL for the previous page of results.
- **results** (array) - List of color objects.

#### Response Example
```json
{
  "next": null,
  "previous": null,
  "results": []
}
```
```

--------------------------------

### Use standard parameters with curl

Source: https://rebrickable.com/api/v3/docs

Example of using the page and ordering parameters on a list endpoint. The ordering parameter uses -name%2Cid to sort by name descending and then by id ascending.

```bash
curl https://rebrickable.com/api/v3/lego/colors/?key=b4e0697ce3d5cf21af1088e9bd238dd&page=2&ordering=-name%2Cid
```

--------------------------------

### Inefficient Part Requests

Source: https://rebrickable.com/api/v3/docs

Example of inefficient API calls that request each part individually, which can be slow and trigger throttle errors.

```http
/lego/parts/3001/
/lego/parts/3002/
/lego/parts/3003/
```

--------------------------------

### Authenticate with key parameter using curl

Source: https://rebrickable.com/api/v3/docs

Use this curl command to authenticate API requests by including a key parameter with your key value. The example uses a fake key b4e0697ce3d5cf21af1088e9bd238dd; replace it with your own key.

```bash
curl https://rebrickable.com/api/v3/lego/colors/?key=b4e0697ce3d5cf21af1088e9bd238dd
```

--------------------------------

### Authenticate with Authorization header using curl

Source: https://rebrickable.com/api/v3/docs

Use this curl command to authenticate API requests by adding an Authorization header with the value 'key <your_key>'. The example uses a fake key b4e0697ce3d5cf21af1088e9bd238dd; replace it with your own key.

```bash
curl --header 'Authorization: key b4e0697ce3d5cf21af1088e9bd238dd' https://rebrickable.com/api/v3/lego/colors/
```

--------------------------------

### Efficient Batch Part Request

Source: https://rebrickable.com/api/v3/docs

Recommended single API call to fetch multiple parts at once, reducing the number of requests and avoiding throttling.

```http
/lego/parts/?part_nums=3001,3002,3003&inc_part_details=1
```
Tokens:
Raw