Spotify

OAuth 2.0 provider for Spotify.

Also see the OAuth 2.0 guide.

Initialization

Pass the client secret for confidential clients.

import * as arctic from "arctic";

const spotify = new arctic.Spotify(clientId, clientSecret, redirectURI);
const spotify = new arctic.Spotify(clientId, null, redirectURI);

Create authorization URL

For confidential clients, pass the state and scopes. PKCE is not supported for confidential clients.

import * as arctic from "arctic";

const state = arctic.generateState();
const scopes = ["user-read-email", "user-read-private"];
const url = spotify.createAuthorizationURL(state, null, scopes);

For public clients, pass the state, PKCE code verifier, and scopes.

import * as arctic from "arctic";

const state = arctic.generateState();
const codeVerifier = arctic.generateCodeVerifier();
const scopes = ["user-read-email", "user-read-private"];
const url = spotify.createAuthorizationURL(state, codeVerifier, scopes);

Validate authorization code

For confidential clients, pass the authorization code.

validateAuthorizationCode() will either return an OAuth2Tokens, or throw one of OAuth2RequestError, ArcticFetchError, UnexpectedResponseError, or UnexpectedErrorResponseBodyError. Spotify returns an access token, the access token expiration, and a refresh token.

import * as arctic from "arctic";

try {
	const tokens = await spotify.validateAuthorizationCode(code, null);
	const accessToken = tokens.accessToken();
	const accessTokenExpiresAt = tokens.accessTokenExpiresAt();
	const refreshToken = tokens.refreshToken();
} catch (e) {
	if (e instanceof arctic.OAuth2RequestError) {
		// Invalid authorization code, credentials, or redirect URI
		const code = e.code;
		// ...
	}
	if (e instanceof arctic.ArcticFetchError) {
		// Failed to call `fetch()`
		const cause = e.cause;
		// ...
	}
	// Parse error
}

For public clients, pass the authorization code and code verifier.

const tokens = await spotify.validateAuthorizationCode(code, codeVerifier);

Refresh access tokens

Use refreshAccessToken() to get a new access token using a refresh token. Spotify returns the same values as during the authorization code validation. This method also returns OAuth2Tokens and throws the same errors as validateAuthorizationCode()

import * as arctic from "arctic";

try {
	const tokens = await spotify.refreshAccessToken(refreshToken);
	const accessToken = tokens.accessToken();
	const accessTokenExpiresAt = tokens.accessTokenExpiresAt();
	const refreshToken = tokens.refreshToken();
} catch (e) {
	if (e instanceof arctic.OAuth2RequestError) {
		// Invalid authorization code, credentials, or redirect URI
	}
	if (e instanceof arctic.ArcticFetchError) {
		// Failed to call `fetch()`
	}
	// Parse error
}

Get user profile

Use the /users/me endpoint. The user-read-email scope is required to get the user's email.

const response = await fetch("https://api.spotify.com/v1/me", {
	headers: {
		Authorization: `Bearer ${accessToken}`
	}
});
const user = await response.json();