Unofficial Spotify API Library

The Unofficial Spotify SDK provides convenient access to the Spotted REST API from applications written in C#.

It is generated with Stainless.

The REST API documentation can be found on spotted.cjav.dev.

Installation

Install the package from NuGet:

dotnet add package Spotted

Requirements

This library requires .NET Standard 2.0 or later.

Usage

See the examples directory for complete and runnable examples.

using System;
using Spotted;
using Spotted.Models.Albums;

SpottedClient client = new();

AlbumRetrieveParams parameters = new() { ID = "4aawyAB9vmqN3uQ7FjRGTy" };

var album = await client.Albums.Retrieve(parameters);

Console.WriteLine(album);

Client configuration

Configure the client using environment variables:

using Spotted;

// Configured using the SPOTIFY_ACCESS_TOKEN and SPOTTED_BASE_URL environment variables
SpottedClient client = new();

Or manually:

using Spotted;

SpottedClient client = new() { AccessToken = "My Access Token" };

Or using a combination of the two approaches.

See this table for the available options:

Property	Environment variable	Required	Default value
AccessToken	SPOTIFY_ACCESS_TOKEN	true	-
BaseUrl	SPOTTED_BASE_URL	true	"https://api.spotify.com/v1"

Modifying configuration

To temporarily use a modified client configuration, while reusing the same connection and thread pools, call WithOptions on any client or service:

using System;

var album = await client
    .WithOptions(options =>
        options with
        {
            BaseUrl = "https://example.com",
            Timeout = TimeSpan.FromSeconds(42),
        }
    )
    .Albums.Retrieve(parameters);

Console.WriteLine(album);

Using a with expression makes it easy to construct the modified options.

The WithOptions method does not affect the original client or service.

Requests and responses

To send a request to the Spotted API, build an instance of some Params class and pass it to the corresponding client method. When the response is received, it will be deserialized into an instance of a C# class.

For example, client.Albums.Retrieve should be called with an instance of AlbumRetrieveParams, and it will return an instance of Task<AlbumRetrieveResponse>.

Binary responses

The SDK defines methods that return binary responses, which are used for API responses that shouldn't necessarily be parsed, like non-JSON data.

These methods return HttpResponse:

using System;
using System.Text;
using Spotted.Models.Playlists.Images;

ImageUpdateParams parameters = new()
{
    PlaylistID = "3cEYpjA9oz9GiPac4AsH4n",
    Body = Encoding.UTF8.GetBytes("Example data"),
};

var image = await client.Playlists.Images.Update(parameters);

Console.WriteLine(image);

To save the response content to a file, or any Stream, use the CopyToAsync method:

using System.IO;

using var response = await client.Playlists.Images.Update(parameters);
using var contentStream = await response.ReadAsStream();
using var fileStream = File.Open(path, FileMode.OpenOrCreate);
await contentStream.CopyToAsync(fileStream); // Or any other Stream

Raw responses

The SDK defines methods that deserialize responses into instances of C# classes. However, these methods don't provide access to the response headers, status code, or the raw response body.

To access this data, prefix any HTTP method call on a client or service with WithRawResponse:

var response = await client.WithRawResponse.Albums.Retrieve(parameters);
var statusCode = response.StatusCode;
var headers = response.Headers;

The raw HttpResponseMessage can also be accessed through the RawMessage property.

For non-streaming responses, you can deserialize the response into an instance of a C# class if needed:

using System;
using Spotted.Models.Albums;

var response = await client.WithRawResponse.Albums.Retrieve(parameters);
AlbumRetrieveResponse deserialized = await response.Deserialize();
Console.WriteLine(deserialized);

Error handling

The SDK throws custom unchecked exception types:

• SpottedApiException: Base class for API errors. See this table for which exception subclass is thrown for each HTTP status code:

Status	Exception
400	SpottedBadRequestException
401	SpottedUnauthorizedException
403	SpottedForbiddenException
404	SpottedNotFoundException
422	SpottedUnprocessableEntityException
429	SpottedRateLimitException
5xx	Spotted5xxException
others	SpottedUnexpectedStatusCodeException

Additionally, all 4xx errors inherit from Spotted4xxException.

• SpottedIOException: I/O networking errors.

• SpottedInvalidDataException: Failure to interpret successfully parsed data. For example, when accessing a property that's supposed to be required, but the API unexpectedly omitted it from the response.

• SpottedException: Base class for all exceptions.

Pagination

The SDK defines methods that return a paginated lists of results. It provides convenient ways to access the results either one page at a time or item-by-item across all pages.

Auto-pagination

To iterate through all results across all pages, use the Paginate method, which automatically fetches more pages as needed. The method returns an IAsyncEnumerable:

using System;

var page = await client.Shows.ListEpisodes(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

Manual pagination

To access individual page items and manually request the next page, use the Items property, and HasNext and Next methods:

using System;

var page = await client.Shows.ListEpisodes(parameters);
while (true)
{
    foreach (var item in page.Items)
    {
        Console.WriteLine(item);
    }
    if (!page.HasNext())
    {
        break;
    }
    page = await page.Next();
}

Network options

Retries

The SDK automatically retries 2 times by default, with a short exponential backoff between requests.

Only the following error types are retried:

• Connection errors (for example, due to a network connectivity problem)
• 408 Request Timeout
• 409 Conflict
• 429 Rate Limit
• 5xx Internal

The API may also explicitly instruct the SDK to retry or not retry a request.

To set a custom number of retries, configure the client using the MaxRetries method:

using Spotted;

SpottedClient client = new() { MaxRetries = 3 };

Or configure a single method call using WithOptions:

using System;

var album = await client
    .WithOptions(options =>
        options with { MaxRetries = 3 }
    )
    .Albums.Retrieve(parameters);

Console.WriteLine(album);

Timeouts

Requests time out after 1 minute by default.

To set a custom timeout, configure the client using the Timeout option:

using System;
using Spotted;

SpottedClient client = new() { Timeout = TimeSpan.FromSeconds(42) };

Or configure a single method call using WithOptions:

using System;

var album = await client
    .WithOptions(options =>
        options with { Timeout = TimeSpan.FromSeconds(42) }
    )
    .Albums.Retrieve(parameters);

Console.WriteLine(album);

Proxies

To route requests through a proxy, configure your client with a custom HttpClient:

using System.Net;
using System.Net.Http;
using Spotted;

var httpClient = new HttpClient
(
    new HttpClientHandler
    {
        Proxy = new WebProxy("https://example.com:8080")
    }
);

SpottedClient client = new() { HttpClient = httpClient };

Undocumented API functionality

The SDK is typed for convenient usage of the documented API. However, it also supports working with undocumented or not yet supported parts of the API.

Parameters

To set undocumented parameters, a constructor exists that accepts dictionaries for additional header, query, and body values. If the method type doesn't support request bodies (e.g. GET requests), the constructor will only accept a header and query dictionary.

using System.Collections.Generic;
using System.Text.Json;
using Spotted.Models.Albums;

AlbumRetrieveParams parameters = new
(
    rawHeaderData: new Dictionary<string, JsonElement>()
    {
        { "Custom-Header", JsonSerializer.SerializeToElement(42) }
    },

    rawQueryData: new Dictionary<string, JsonElement>()
    {
        { "custom_query_param", JsonSerializer.SerializeToElement(42) }
    }
)
{
    // Documented properties can still be added here.
    // In case of conflict, these parameters take precedence over the custom parameters.
    ID = "4aawyAB9vmqN3uQ7FjRGTy"
};

The raw parameters can also be accessed through the RawHeaderData, RawQueryData, and RawBodyData (if available) properties.

This can also be used to set a documented parameter to an undocumented or not yet supported value, as long as the parameter is optional. If the parameter is required, omitting its init property will result in a compile-time error. To work around this, the FromRawUnchecked method can be used:

using System.Collections.Generic;
using System.Text.Json;
using Spotted.Models.Albums;

var parameters = AlbumBulkRetrieveParams.FromRawUnchecked
(

    rawHeaderData: new Dictionary<string, JsonElement>(),
    rawQueryData: new Dictionary<string, JsonElement>
    {
        {
            "ids",
            JsonSerializer.SerializeToElement("custom value")
        }
    }
);

Response properties

To access undocumented response properties, the RawData property can be used:

using System.Text.Json;

var response = client.Albums.Retrieve(parameters)
if (response.RawData.TryGetValue("my_custom_key", out JsonElement value))
{
    // Do something with `value`
}

RawData is a IReadonlyDictionary<string, JsonElement>. It holds the full data received from the API server.

Response validation

In rare cases, the API may return a response that doesn't match the expected type. For example, the SDK may expect a property to contain a string, but the API could return something else.

By default, the SDK will not throw an exception in this case. It will throw SpottedInvalidDataException only if you directly access the property.

If you would prefer to check that the response is completely well-typed upfront, then either call Validate:

var album = client.Albums.Retrieve(parameters);
album.Validate();

Or configure the client using the ResponseValidation option:

using Spotted;

SpottedClient client = new() { ResponseValidation = true };

Or configure a single method call using WithOptions:

using System;

var album = await client
    .WithOptions(options =>
        options with { ResponseValidation = true }
    )
    .Albums.Retrieve(parameters);

Console.WriteLine(album);

Semantic versioning

This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

1. Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals.)
2. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an issue with questions, bugs, or suggestions.