Getting Started with the Audius SDK
Overview
The Audius JavaScript (TypeScript) SDK allows you to easily interact with the Audius protocol. Use the SDK to:
- π Search and display users, tracks, and playlists
- π΅ Stream and upload tracks
- β€οΈΒ Favorite, repost, and curate playlists
- βοΈ Allow your users to log in with their Audius account and act on their behalf
...and much more!
API Plans
Audius offers two API plans:
| Free | 10 requests/second | 500,000 requests/month |
| Unlimited | Unlimited | Unlimited |
The Free plan is always free with no restrictions. For higher limits and support, contact api@audius.co about the Unlimited plan.
Get Your API Key
- API Key β used in all contexts (frontend and backend). Safe to include in client-side code.
- Bearer Token β backend only. Grants your app the ability to act on behalf of users who have authorized it. Never expose this in browser or mobile code.
Install the SDK
Node.js
If your project is in a Node.js environment, run this in your terminal:
npm install @audius/sdk
@audius/sdk on NPM
HTML + JS
Otherwise, include the SDK script tag in your web page. The Audius SDK will then be assigned to window.audiusSdk.
<script src="https://cdn.jsdelivr.net/npm/@audius/sdk@latest/dist/sdk.min.js"></script>
Initialize the SDK
How you initialize the SDK depends on whether you are running in a backend (Node.js) or frontend (browser/mobile) context.
Node.js (backend) example
Include your API key and bearer token. The bearer token enables your app to perform actions on behalf of authorized users.
import { sdk } from '@audius/sdk'
const audiusSdk = sdk({
apiKey: 'Your API Key goes here',
bearerToken: 'Your Bearer Token goes here'
})
HTML + JS (frontend) example
In a browser or mobile context, initialize with your API key only β no bearer token. User authentication is handled via the OAuth flow described below.
const audiusSdk = window.audiusSdk({
apiKey: 'Your API Key goes here'
})
:::warning
Never include your bearer token in frontend code. The bearer token allows your app to act on behalf of users who have authorized it. Exposing it in client-side code (browser or mobile) is a critical security risk β anyone who inspects your code could use it to impersonate your app.
For frontend apps, use the OAuth flow instead.
:::
Make your first API call using the SDK
Once you have the initialized SDK instance, it's smooth sailing to making your first API calls.
const track = await audiusSdk.tracks.getTrack({ trackId: 'D7KyD' })
console.log(track, 'Track fetched!')
const userId = (
await audiusSdk.users.getUserByHandle({
handle: 'Your Audius handle goes here'
})
).data?.id
await audiusSdk.tracks.favoriteTrack({
trackId: 'D7KyD',
userId
})
Full Node.js example
import { sdk } from '@audius/sdk'
const audiusSdk = sdk({
apiKey: 'Your API Key goes here',
bearerToken: 'Your Bearer Token goes here'
})
const track = await audiusSdk.tracks.getTrack({ trackId: 'D7KyD' })
console.log(track, 'Track fetched!')
const userId = (
await audiusSdk.users.getUserByHandle({
handle: 'Your Audius handle goes here'
})
).data?.id
await audiusSdk.tracks.favoriteTrack({
trackId: 'D7KyD',
userId
})
console.log('Track favorited!')
Full HTML + JS example
<!DOCTYPE html>
<html>
<head>
<script src="https://cdn.jsdelivr.net/npm/@audius/sdk@latest/dist/sdk.min.js"></script>
<script>
const fn = async () => {
const audiusSdk = window.audiusSdk({
apiKey: 'Your API Key goes here'
})
const track = await audiusSdk.tracks.getTrack({ trackId: 'D7KyD' })
console.log(track, 'Track fetched!')
}
fn()
</script>
</head>
<body>
<h1>Example content</h1>
</body>
</html>
Log In with Audius (OAuth)
For frontend apps, use the built-in OAuth 2.0 PKCE flow to authenticate users. This lets your users log in with their Audius account and authorize your app to act on their behalf β without exposing your app's bearer token in client-side code.
const audiusSdk = window.audiusSdk({
apiKey: 'Your API Key goes here',
redirectUri: 'https://your-app.com/oauth/callback'
})
audiusSdk.oauth.login()
await audiusSdk.oauth.handleRedirectCallback()
After the user logs in, the SDK stores their access token automatically and includes it in subsequent API calls. See the Log In with Audius guide for the full flow.
What's next?
Direct API Access
You can also access the Audius API directly without the SDK. The examples below use a bearer token and are intended for backend/server-side use only β do not use your bearer token in browser or mobile code.
REST API:
curl -X GET "https://api.audius.co/v1/tracks/trending" \
-H "Authorization: Bearer <YOUR-API-BEARER-TOKEN>"
gRPC:
grpcurl -H "authorization: Bearer <YOUR-API-BEARER-TOKEN>" \
grpc.audius.co:443 list
For more details, visit the API documentation or the Swagger definition.