Skip to content
Praxrr

Get Arr instance library

GET
/arr/library
curl --request GET \
  --url 'https://example.com/api/v1/arr/library?instanceId=1&page=1&pageSize=100&sortDirection=asc'

Fetches the full library from an Arr instance with quality profile, score, and progress information.

  • For Radarr: Returns movies with file quality, custom format scores, and cutoff progress
  • For Sonarr: Returns series with season summaries and episode statistics
  • For Lidarr: Returns artists/albums (capability-gated; detailed payload fields deferred to later phases)

Results include Praxrr profile matching to indicate which items use managed profiles. Responses are cached server-side for 5 minutes. Supports server-side filtering, sorting, and pagination.

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
instanceId
required
integer

Arr instance ID

page
integer
default: 1 >= 1

Pagination page number (1-based)

pageSize
integer
default: 100 >= 1 <= 250

Maximum number of items per page. Values above 250 are capped at 250.

sortKey
string

Optional sort field. Must be valid for the target Arr type (radarr, sonarr, or lidarr) or request will be rejected.

sortDirection
string
default: asc
Allowed values: asc desc

Sort order for the sortKey field.

query
string

Optional case-insensitive text filter applied before sorting and pagination.

Responses

Section titled “Responses”

200

Section titled “200”

Library items with quality and score data

Media typeapplication/json
One of:
object
type
required
string
Allowed values: radarr
items
required
Array<object>
object
id
required

Radarr movie ID

integer
tmdbId

TMDB ID

integer
title
required

Movie title

string
year

Release year

integer
qualityProfileId
required

Assigned quality profile ID

integer
qualityProfileName
required

Assigned quality profile name

string
hasFile
required

Whether the movie has a downloaded file

boolean
dateAdded

When the movie was added

string format: date-time
popularity

TMDB popularity score

number
qualityName

Quality of the downloaded file (null if no file)

string
nullable
fileName

File name of the downloaded file (null if no file)

string
nullable
customFormats
required

Custom formats matched on the file

Array<object>
object
id
required

Custom format ID

integer
name
required

Custom format name

string
customFormatScore
required

Total custom format score

integer
scoreBreakdown
required

Per-custom-format score breakdown

Array<object>
object
name
required

Custom format name

string
score
required

Score assigned by the quality profile

integer
cutoffScore
required

Profile cutoff score threshold

integer
minScore
required

Profile minimum score threshold

integer
progress
required

Score progress toward cutoff (0-1+)

number
cutoffMet
required

Whether the cutoff score has been met

boolean
isPraxrrProfile
required

Whether the profile is managed by Praxrr

boolean
profilesByDatabase
required
Array<object>
object
databaseId
required

Praxrr database ID

integer
databaseName
required

Praxrr database name

string
profiles
required

Quality profile names in this database

Array<string>
page
required

Current page number

integer
pageSize
required

Current items per page

integer
totalRecords
required

Total number of records after search/filtering before pagination

integer
totalPages
required

Total page count derived from totalRecords and pageSize

integer
hasNext
required

Indicates whether additional pages are available

boolean
Example
{
  "type": "radarr"
}

400

Section titled “400”

Invalid instanceId, page, or sort/query parameters

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
  "error": "example"
}

404

Section titled “404”

Instance not found

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
  "error": "example"
}

500

Section titled “500”

Failed to fetch library

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
  "error": "example"
}