mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Mintlify Agent
65fd3621dc
- Created 111 MDX documentation files - Added 89 API endpoint pages across 14 categories - Included 11 concept guides and 7 tutorials - Configured Mintlify with Spotify branding (#1DB954) - All pages validated successfully
139 lines
4.0 KiB
Plaintext
139 lines
4.0 KiB
Plaintext
---
|
|
title: "API Reference"
|
|
description: "Complete reference for all Spotify Web API endpoints"
|
|
---
|
|
|
|
# API Reference
|
|
|
|
The Spotify Web API provides endpoints for accessing Spotify's music catalog and user data. All endpoints are organized by resource type for easy navigation.
|
|
|
|
## Base URL
|
|
|
|
```
|
|
https://api.spotify.com/v1
|
|
```
|
|
|
|
## Authentication
|
|
|
|
All API requests require authentication with an access token:
|
|
|
|
```bash
|
|
curl -X GET "https://api.spotify.com/v1/endpoint" \
|
|
-H "Authorization: Bearer {access_token}"
|
|
```
|
|
|
|
Learn more about [authentication](/getting-started/authentication-flows).
|
|
|
|
## Endpoint categories
|
|
|
|
<CardGroup cols={3}>
|
|
<Card title="Albums" icon="album-collection" href="/api-reference/albums/get-album">
|
|
Album information and user's saved albums
|
|
</Card>
|
|
<Card title="Artists" icon="microphone" href="/api-reference/artists/get-artist">
|
|
Artist details, albums, and top tracks
|
|
</Card>
|
|
<Card title="Audiobooks" icon="book-audio" href="/api-reference/audiobooks/get-audiobook">
|
|
Audiobook catalog and user library
|
|
</Card>
|
|
<Card title="Categories" icon="folder" href="/api-reference/categories/get-several-categories">
|
|
Browse categories for content discovery
|
|
</Card>
|
|
<Card title="Chapters" icon="book-open" href="/api-reference/chapters/get-chapter">
|
|
Audiobook chapter information
|
|
</Card>
|
|
<Card title="Episodes" icon="podcast" href="/api-reference/episodes/get-episode">
|
|
Podcast episode details
|
|
</Card>
|
|
<Card title="Genres" icon="music" href="/api-reference/genres/get-genre-seeds">
|
|
Available genre seeds
|
|
</Card>
|
|
<Card title="Markets" icon="globe" href="/api-reference/markets/get-available-markets">
|
|
Spotify market availability
|
|
</Card>
|
|
<Card title="Player" icon="play" href="/api-reference/player/get-playback-state">
|
|
Playback control and state
|
|
</Card>
|
|
<Card title="Playlists" icon="list" href="/api-reference/playlists/get-playlist">
|
|
Playlist management
|
|
</Card>
|
|
<Card title="Search" icon="search" href="/api-reference/search/search">
|
|
Search the Spotify catalog
|
|
</Card>
|
|
<Card title="Shows" icon="microphone-stand" href="/api-reference/shows/get-show">
|
|
Podcast show information
|
|
</Card>
|
|
<Card title="Tracks" icon="music-note" href="/api-reference/tracks/get-track">
|
|
Track details and audio features
|
|
</Card>
|
|
<Card title="Users" icon="user" href="/api-reference/users/get-current-user">
|
|
User profiles and preferences
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
## Common parameters
|
|
|
|
Many endpoints share these parameters:
|
|
|
|
<ParamField query="market" type="string">
|
|
ISO 3166-1 alpha-2 country code for localized content
|
|
</ParamField>
|
|
|
|
<ParamField query="limit" type="integer" default="20">
|
|
Maximum number of items to return (max usually 50)
|
|
</ParamField>
|
|
|
|
<ParamField query="offset" type="integer" default="0">
|
|
Index of first item to return (for pagination)
|
|
</ParamField>
|
|
|
|
## Response format
|
|
|
|
Successful responses return JSON with appropriate status codes:
|
|
|
|
- `200 OK` - Request succeeded
|
|
- `201 Created` - Resource created
|
|
- `204 No Content` - Request succeeded with no response body
|
|
|
|
## Error handling
|
|
|
|
Error responses include a status code and error object:
|
|
|
|
```json
|
|
{
|
|
"error": {
|
|
"status": 401,
|
|
"message": "Invalid access token"
|
|
}
|
|
}
|
|
```
|
|
|
|
Learn more about [error handling](/getting-started/making-api-calls#error-handling).
|
|
|
|
## Rate limits
|
|
|
|
API requests are rate limited. Monitor these headers:
|
|
|
|
- `X-RateLimit-Limit` - Rate limit ceiling
|
|
- `X-RateLimit-Remaining` - Remaining requests
|
|
- `X-RateLimit-Reset` - Reset time (Unix timestamp)
|
|
|
|
Learn more about [rate limits](/concepts/rate-limits).
|
|
|
|
## Getting started
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Authentication" href="/getting-started/authentication-flows">
|
|
Choose an authentication flow
|
|
</Card>
|
|
<Card title="Making API calls" href="/getting-started/making-api-calls">
|
|
Learn how to make requests
|
|
</Card>
|
|
<Card title="Tutorials" href="/tutorials/getting-started">
|
|
Follow step-by-step guides
|
|
</Card>
|
|
<Card title="Concepts" href="/concepts/authorization">
|
|
Understand core concepts
|
|
</Card>
|
|
</CardGroup>
|