OAuth 2.0 provider for Twitter API v2.
Also see the OAuth 2.0 with PKCE guide.
Initialization
import { Twitter } from "arctic";
const twitter = new Twitter(clientId, clientSecret, redirectURI);
Create authorization URL
import { generateState } from "arctic";
const state = generateState();
const scopes = ["account_info.read", "files.content.read"];
const url = twitter.createAuthorizationURL(state, codeVerifier, scopes);
Validate authorization code
validateAuthorizationCode()
will either return an OAuth2Tokens
, or throw one of OAuth2RequestError
, ArcticFetchError
, or a standard Error
(parse errors). Twitter returns an access token and its expiration.
import { OAuth2RequestError, ArcticFetchError } from "arctic";
try {
const tokens = await twitter.validateAuthorizationCode(code, codeVerifier);
const accessToken = tokens.accessToken();
const accessTokenExpiresAt = tokens.accessTokenExpiresAt();
} catch (e) {
if (e instanceof OAuth2RequestError) {
// Invalid authorization code, credentials, or redirect URI
const code = e.code;
// ...
}
if (e instanceof ArcticFetchError) {
// Failed to call `fetch()`
const cause = e.cause;
// ...
}
// Parse error
}
Get user profile
Add the users.read
and tweet.read
scopes and use the /users/me
endpoint. You cannot get user emails with the v2 API.
const scopes = ["users.read", "tweet.read"];
const url = twitter.createAuthorizationURL(state, codeVerifier, scopes);
const response = await fetch("https://api.twitter.com/2/users/me", {
headers: {
Authorization: `Bearer ${accessToken}`
}
});
const user = await response.json();
Refresh access tokens
Add the offline.access
scope to get refresh tokens.
const scopes = ["offline.access"];
const url = twitter.createAuthorizationURL(state, codeVerifier, scopes);
const tokens = await twitter.validateAuthorizationCode(code, codeVerifier);
const accessToken = tokens.accessToken();
const accessTokenExpiresAt = tokens.accessTokenExpiresAt();
const refreshToken = tokens.refreshToken();
Use refreshAccessToken()
to get a new access token using a refresh token. Twitter returns the same values as during the authorization code validation. This method also returns OAuth2Tokens
and throws the same errors as validateAuthorizationCode()
import { OAuth2RequestError, ArcticFetchError } from "arctic";
try {
const tokens = await twitter.refreshAccessToken(refreshToken);
const accessToken = tokens.accessToken();
const accessTokenExpiresAt = tokens.accessTokenExpiresAt();
const refreshToken = tokens.refreshToken();
} catch (e) {
if (e instanceof OAuth2RequestError) {
// Invalid authorization code, credentials, or redirect URI
}
if (e instanceof ArcticFetchError) {
// Failed to call `fetch()`
}
// Parse error
}
Revoke tokens
Use revokeToken()
to revoke a token. This can throw the same errors as validateAuthorizationCode()
.
try {
await twitter.revokeToken(refreshToken);
} catch (e) {
if (e instanceof OAuth2RequestError) {
// Invalid authorization code, credentials, or redirect URI
}
if (e instanceof ArcticFetchError) {
// Failed to call `fetch()`
}
// Parse error
}