Skip to content

Latest commit

 

History

History
170 lines (121 loc) · 12.3 KB

README.md

File metadata and controls

170 lines (121 loc) · 12.3 KB
Raw

Search

(Search)

Overview

API Calls that perform search operations with Plex Media Server

Available Operations

PerformSearch

This endpoint performs a search across all library sections, or a single section, and returns matches as hubs, split up by type. It performs spell checking, looks for partial matches, and orders the hubs based on quality of results. In addition, based on matches, it will return other related matches (e.g. for a genre match, it may return movies in that genre, or for an actor match, movies with that actor).

In the response's items, the following extra attributes are returned to further describe or disambiguate the result:

  • reason: The reason for the result, if not because of a direct search term match; can be either:
    • section: There are multiple identical results from different sections.
    • originalTitle: There was a search term match from the original title field (sometimes those can be very different or in a foreign language).
    • <hub identifier>: If the reason for the result is due to a result in another hub, the source hub identifier is returned. For example, if the search is for "dylan" then Bob Dylan may be returned as an artist result, an a few of his albums returned as album results with a reason code of artist (the identifier of that particular hub). Or if the search is for "arnold", there might be movie results returned with a reason of actor
  • reasonTitle: The string associated with the reason code. For a section reason, it'll be the section name; For a hub identifier, it'll be a string associated with the match (e.g. Arnold Schwarzenegger for movies which were returned because the search was for "arnold").
  • reasonID: The ID of the item associated with the reason for the result. This might be a section ID, a tag ID, an artist ID, or a show ID.

This request is intended to be very fast, and called as the user types.

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Requests;
using LukeHagar.PlexAPI.SDK.Models.Components;

var sdk = new PlexAPI(
    accessToken: "<YOUR_API_KEY_HERE>",
    clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
    clientName: "Plex for Roku",
    clientVersion: "2.4.1",
    platform: "Roku",
    deviceNickname: "Roku 3"
);

var res = await sdk.Search.PerformSearchAsync(
    query: "dylan",
    sectionId: 9372.69D,
    limit: 5D
);

// handle response

Parameters

Parameter Type Required Description Example
Query string ✔️ The query term arnold
SectionId double ➖ This gives context to the search, and can result in re-ordering of search result hubs
Limit double ➖ The number of items to return per hub 5

Response

PerformSearchResponse

Errors

Error Type Status Code Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.PerformSearchBadRequest 400 application/json
LukeHagar.PlexAPI.SDK.Models.Errors.PerformSearchUnauthorized 401 application/json
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException 4XX, 5XX */*

PerformVoiceSearch

This endpoint performs a search specifically tailored towards voice or other imprecise input which may work badly with the substring and spell-checking heuristics used by the /hubs/search endpoint. It uses a Levenshtein distance heuristic to search titles, and as such is much slower than the other search endpoint. Whenever possible, clients should limit the search to the appropriate type. Results, as well as their containing per-type hubs, contain a distance attribute which can be used to judge result quality.

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Requests;
using LukeHagar.PlexAPI.SDK.Models.Components;

var sdk = new PlexAPI(
    accessToken: "<YOUR_API_KEY_HERE>",
    clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
    clientName: "Plex for Roku",
    clientVersion: "2.4.1",
    platform: "Roku",
    deviceNickname: "Roku 3"
);

var res = await sdk.Search.PerformVoiceSearchAsync(
    query: "dead+poop",
    sectionId: 4094.80D,
    limit: 5D
);

// handle response

Parameters

Parameter Type Required Description Example
Query string ✔️ The query term dead+poop
SectionId double ➖ This gives context to the search, and can result in re-ordering of search result hubs
Limit double ➖ The number of items to return per hub 5

Response

PerformVoiceSearchResponse

Errors

Error Type Status Code Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.PerformVoiceSearchBadRequest 400 application/json
LukeHagar.PlexAPI.SDK.Models.Errors.PerformVoiceSearchUnauthorized 401 application/json
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException 4XX, 5XX */*

GetSearchResults

This will search the database for the string provided.

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Requests;
using LukeHagar.PlexAPI.SDK.Models.Components;

var sdk = new PlexAPI(
    accessToken: "<YOUR_API_KEY_HERE>",
    clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
    clientName: "Plex for Roku",
    clientVersion: "2.4.1",
    platform: "Roku",
    deviceNickname: "Roku 3"
);

var res = await sdk.Search.GetSearchResultsAsync(query: "110");

// handle response

Parameters

Parameter Type Required Description Example
Query string ✔️ The search query string to use 110

Response

GetSearchResultsResponse

Errors

Error Type Status Code Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.GetSearchResultsBadRequest 400 application/json
LukeHagar.PlexAPI.SDK.Models.Errors.GetSearchResultsUnauthorized 401 application/json
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException 4XX, 5XX */*