Skip to content

Latest commit

 

History

History
1342 lines (883 loc) · 39.6 KB

SearchAPI.md

File metadata and controls

1342 lines (883 loc) · 39.6 KB

\SearchAPI

All URIs are relative to http://localhost:5055/api/v1

Method HTTP request Description
GetDiscoverKeywordMovies Get /discover/keyword/{keywordId}/movies Get movies from keyword
GetDiscoverMovies Get /discover/movies Discover movies
GetDiscoverMoviesGenreByGenreId Get /discover/movies/genre/{genreId} Discover movies by genre
GetDiscoverMoviesLanguageByLanguage Get /discover/movies/language/{language} Discover movies by original language
GetDiscoverMoviesStudioByStudioId Get /discover/movies/studio/{studioId} Discover movies by studio
GetDiscoverMoviesUpcoming Get /discover/movies/upcoming Upcoming movies
GetDiscoverTrending Get /discover/trending Trending movies and TV
GetDiscoverTv Get /discover/tv Discover TV shows
GetDiscoverTvGenreByGenreId Get /discover/tv/genre/{genreId} Discover TV shows by genre
GetDiscoverTvLanguageByLanguage Get /discover/tv/language/{language} Discover TV shows by original language
GetDiscoverTvNetworkByNetworkId Get /discover/tv/network/{networkId} Discover TV shows by network
GetDiscoverTvUpcoming Get /discover/tv/upcoming Discover Upcoming TV shows
GetDiscoverWatchlist Get /discover/watchlist Get the Plex watchlist.
GetSearch Get /search Search for movies, TV shows, or people
GetSearchCompany Get /search/company Search for companies
GetSearchKeyword Get /search/keyword Search for keywords
ListDiscoverGenresliderMovie Get /discover/genreslider/movie Get genre slider data for movies
ListDiscoverGenresliderTv Get /discover/genreslider/tv Get genre slider data for TV series

GetDiscoverKeywordMovies

GetDiscoverMovies2XXResponse GetDiscoverKeywordMovies(ctx, keywordId).Page(page).Language(language).Execute()

Get movies from keyword

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	keywordId := float32(207317) // float32 | 
	page := float32(1) // float32 |  (optional) (default to 1)
	language := "en" // string |  (optional)

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.SearchAPI.GetDiscoverKeywordMovies(context.Background(), keywordId).Page(page).Language(language).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.GetDiscoverKeywordMovies``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetDiscoverKeywordMovies`: GetDiscoverMovies2XXResponse
	fmt.Fprintf(os.Stdout, "Response from `SearchAPI.GetDiscoverKeywordMovies`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
keywordId float32

Other Parameters

Other parameters are passed through a pointer to a apiGetDiscoverKeywordMoviesRequest struct via the builder pattern

Name Type Description Notes

page | float32 | | [default to 1] language | string | |

Return type

GetDiscoverMovies2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDiscoverMovies

GetDiscoverMovies2XXResponse GetDiscoverMovies(ctx).Page(page).Language(language).Genre(genre).Studio(studio).Keywords(keywords).SortBy(sortBy).PrimaryReleaseDateGte(primaryReleaseDateGte).PrimaryReleaseDateLte(primaryReleaseDateLte).WithRuntimeGte(withRuntimeGte).WithRuntimeLte(withRuntimeLte).VoteAverageGte(voteAverageGte).VoteAverageLte(voteAverageLte).VoteCountGte(voteCountGte).VoteCountLte(voteCountLte).WatchRegion(watchRegion).WatchProviders(watchProviders).Execute()

Discover movies

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	page := float32(1) // float32 |  (optional) (default to 1)
	language := "en" // string |  (optional)
	genre := "18" // string |  (optional)
	studio := float32(1) // float32 |  (optional)
	keywords := "1,2" // string |  (optional)
	sortBy := "popularity.desc" // string |  (optional)
	primaryReleaseDateGte := "2022-01-01T00:00:00Z" // string |  (optional)
	primaryReleaseDateLte := "2023-01-01T00:00:00Z" // string |  (optional)
	withRuntimeGte := float32(60) // float32 |  (optional)
	withRuntimeLte := float32(120) // float32 |  (optional)
	voteAverageGte := float32(7) // float32 |  (optional)
	voteAverageLte := float32(10) // float32 |  (optional)
	voteCountGte := float32(7) // float32 |  (optional)
	voteCountLte := float32(10) // float32 |  (optional)
	watchRegion := "US" // string |  (optional)
	watchProviders := "8|9" // string |  (optional)

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.SearchAPI.GetDiscoverMovies(context.Background()).Page(page).Language(language).Genre(genre).Studio(studio).Keywords(keywords).SortBy(sortBy).PrimaryReleaseDateGte(primaryReleaseDateGte).PrimaryReleaseDateLte(primaryReleaseDateLte).WithRuntimeGte(withRuntimeGte).WithRuntimeLte(withRuntimeLte).VoteAverageGte(voteAverageGte).VoteAverageLte(voteAverageLte).VoteCountGte(voteCountGte).VoteCountLte(voteCountLte).WatchRegion(watchRegion).WatchProviders(watchProviders).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.GetDiscoverMovies``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetDiscoverMovies`: GetDiscoverMovies2XXResponse
	fmt.Fprintf(os.Stdout, "Response from `SearchAPI.GetDiscoverMovies`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetDiscoverMoviesRequest struct via the builder pattern

Name Type Description Notes
page float32 [default to 1]
language string
genre string
studio float32
keywords string
sortBy string
primaryReleaseDateGte string
primaryReleaseDateLte string
withRuntimeGte float32
withRuntimeLte float32
voteAverageGte float32
voteAverageLte float32
voteCountGte float32
voteCountLte float32
watchRegion string
watchProviders string

Return type

GetDiscoverMovies2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDiscoverMoviesGenreByGenreId

GetDiscoverMoviesGenreByGenreId2XXResponse GetDiscoverMoviesGenreByGenreId(ctx, genreId).Page(page).Language(language).Execute()

Discover movies by genre

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	genreId := "1" // string | 
	page := float32(1) // float32 |  (optional) (default to 1)
	language := "en" // string |  (optional)

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.SearchAPI.GetDiscoverMoviesGenreByGenreId(context.Background(), genreId).Page(page).Language(language).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.GetDiscoverMoviesGenreByGenreId``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetDiscoverMoviesGenreByGenreId`: GetDiscoverMoviesGenreByGenreId2XXResponse
	fmt.Fprintf(os.Stdout, "Response from `SearchAPI.GetDiscoverMoviesGenreByGenreId`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
genreId string

Other Parameters

Other parameters are passed through a pointer to a apiGetDiscoverMoviesGenreByGenreIdRequest struct via the builder pattern

Name Type Description Notes

page | float32 | | [default to 1] language | string | |

Return type

GetDiscoverMoviesGenreByGenreId2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDiscoverMoviesLanguageByLanguage

GetDiscoverMoviesLanguageByLanguage2XXResponse GetDiscoverMoviesLanguageByLanguage(ctx, language).Page(page).Language2(language2).Execute()

Discover movies by original language

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	language := "en" // string | 
	page := float32(1) // float32 |  (optional) (default to 1)
	language2 := "en" // string |  (optional)

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.SearchAPI.GetDiscoverMoviesLanguageByLanguage(context.Background(), language).Page(page).Language2(language2).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.GetDiscoverMoviesLanguageByLanguage``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetDiscoverMoviesLanguageByLanguage`: GetDiscoverMoviesLanguageByLanguage2XXResponse
	fmt.Fprintf(os.Stdout, "Response from `SearchAPI.GetDiscoverMoviesLanguageByLanguage`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
language string

Other Parameters

Other parameters are passed through a pointer to a apiGetDiscoverMoviesLanguageByLanguageRequest struct via the builder pattern

Name Type Description Notes

page | float32 | | [default to 1] language2 | string | |

Return type

GetDiscoverMoviesLanguageByLanguage2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDiscoverMoviesStudioByStudioId

GetDiscoverMoviesStudioByStudioId2XXResponse GetDiscoverMoviesStudioByStudioId(ctx, studioId).Page(page).Language(language).Execute()

Discover movies by studio

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	studioId := "1" // string | 
	page := float32(1) // float32 |  (optional) (default to 1)
	language := "en" // string |  (optional)

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.SearchAPI.GetDiscoverMoviesStudioByStudioId(context.Background(), studioId).Page(page).Language(language).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.GetDiscoverMoviesStudioByStudioId``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetDiscoverMoviesStudioByStudioId`: GetDiscoverMoviesStudioByStudioId2XXResponse
	fmt.Fprintf(os.Stdout, "Response from `SearchAPI.GetDiscoverMoviesStudioByStudioId`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
studioId string

Other Parameters

Other parameters are passed through a pointer to a apiGetDiscoverMoviesStudioByStudioIdRequest struct via the builder pattern

Name Type Description Notes

page | float32 | | [default to 1] language | string | |

Return type

GetDiscoverMoviesStudioByStudioId2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDiscoverMoviesUpcoming

GetDiscoverMovies2XXResponse GetDiscoverMoviesUpcoming(ctx).Page(page).Language(language).Execute()

Upcoming movies

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	page := float32(1) // float32 |  (optional) (default to 1)
	language := "en" // string |  (optional)

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.SearchAPI.GetDiscoverMoviesUpcoming(context.Background()).Page(page).Language(language).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.GetDiscoverMoviesUpcoming``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetDiscoverMoviesUpcoming`: GetDiscoverMovies2XXResponse
	fmt.Fprintf(os.Stdout, "Response from `SearchAPI.GetDiscoverMoviesUpcoming`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetDiscoverMoviesUpcomingRequest struct via the builder pattern

Name Type Description Notes
page float32 [default to 1]
language string

Return type

GetDiscoverMovies2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDiscoverTrending

GetSearch2XXResponse GetDiscoverTrending(ctx).Page(page).Language(language).Execute()

Trending movies and TV

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	page := float32(1) // float32 |  (optional) (default to 1)
	language := "en" // string |  (optional)

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.SearchAPI.GetDiscoverTrending(context.Background()).Page(page).Language(language).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.GetDiscoverTrending``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetDiscoverTrending`: GetSearch2XXResponse
	fmt.Fprintf(os.Stdout, "Response from `SearchAPI.GetDiscoverTrending`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetDiscoverTrendingRequest struct via the builder pattern

Name Type Description Notes
page float32 [default to 1]
language string

Return type

GetSearch2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDiscoverTv

GetDiscoverTv2XXResponse GetDiscoverTv(ctx).Page(page).Language(language).Genre(genre).Network(network).Keywords(keywords).SortBy(sortBy).FirstAirDateGte(firstAirDateGte).FirstAirDateLte(firstAirDateLte).WithRuntimeGte(withRuntimeGte).WithRuntimeLte(withRuntimeLte).VoteAverageGte(voteAverageGte).VoteAverageLte(voteAverageLte).VoteCountGte(voteCountGte).VoteCountLte(voteCountLte).WatchRegion(watchRegion).WatchProviders(watchProviders).Execute()

Discover TV shows

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	page := float32(1) // float32 |  (optional) (default to 1)
	language := "en" // string |  (optional)
	genre := "18" // string |  (optional)
	network := float32(1) // float32 |  (optional)
	keywords := "1,2" // string |  (optional)
	sortBy := "popularity.desc" // string |  (optional)
	firstAirDateGte := "2022-01-01T00:00:00Z" // string |  (optional)
	firstAirDateLte := "2023-01-01T00:00:00Z" // string |  (optional)
	withRuntimeGte := float32(60) // float32 |  (optional)
	withRuntimeLte := float32(120) // float32 |  (optional)
	voteAverageGte := float32(7) // float32 |  (optional)
	voteAverageLte := float32(10) // float32 |  (optional)
	voteCountGte := float32(7) // float32 |  (optional)
	voteCountLte := float32(10) // float32 |  (optional)
	watchRegion := "US" // string |  (optional)
	watchProviders := "8|9" // string |  (optional)

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.SearchAPI.GetDiscoverTv(context.Background()).Page(page).Language(language).Genre(genre).Network(network).Keywords(keywords).SortBy(sortBy).FirstAirDateGte(firstAirDateGte).FirstAirDateLte(firstAirDateLte).WithRuntimeGte(withRuntimeGte).WithRuntimeLte(withRuntimeLte).VoteAverageGte(voteAverageGte).VoteAverageLte(voteAverageLte).VoteCountGte(voteCountGte).VoteCountLte(voteCountLte).WatchRegion(watchRegion).WatchProviders(watchProviders).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.GetDiscoverTv``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetDiscoverTv`: GetDiscoverTv2XXResponse
	fmt.Fprintf(os.Stdout, "Response from `SearchAPI.GetDiscoverTv`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetDiscoverTvRequest struct via the builder pattern

Name Type Description Notes
page float32 [default to 1]
language string
genre string
network float32
keywords string
sortBy string
firstAirDateGte string
firstAirDateLte string
withRuntimeGte float32
withRuntimeLte float32
voteAverageGte float32
voteAverageLte float32
voteCountGte float32
voteCountLte float32
watchRegion string
watchProviders string

Return type

GetDiscoverTv2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDiscoverTvGenreByGenreId

GetDiscoverTvGenreByGenreId2XXResponse GetDiscoverTvGenreByGenreId(ctx, genreId).Page(page).Language(language).Execute()

Discover TV shows by genre

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	genreId := "1" // string | 
	page := float32(1) // float32 |  (optional) (default to 1)
	language := "en" // string |  (optional)

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.SearchAPI.GetDiscoverTvGenreByGenreId(context.Background(), genreId).Page(page).Language(language).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.GetDiscoverTvGenreByGenreId``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetDiscoverTvGenreByGenreId`: GetDiscoverTvGenreByGenreId2XXResponse
	fmt.Fprintf(os.Stdout, "Response from `SearchAPI.GetDiscoverTvGenreByGenreId`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
genreId string

Other Parameters

Other parameters are passed through a pointer to a apiGetDiscoverTvGenreByGenreIdRequest struct via the builder pattern

Name Type Description Notes

page | float32 | | [default to 1] language | string | |

Return type

GetDiscoverTvGenreByGenreId2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDiscoverTvLanguageByLanguage

GetDiscoverTvLanguageByLanguage2XXResponse GetDiscoverTvLanguageByLanguage(ctx, language).Page(page).Language2(language2).Execute()

Discover TV shows by original language

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	language := "en" // string | 
	page := float32(1) // float32 |  (optional) (default to 1)
	language2 := "en" // string |  (optional)

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.SearchAPI.GetDiscoverTvLanguageByLanguage(context.Background(), language).Page(page).Language2(language2).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.GetDiscoverTvLanguageByLanguage``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetDiscoverTvLanguageByLanguage`: GetDiscoverTvLanguageByLanguage2XXResponse
	fmt.Fprintf(os.Stdout, "Response from `SearchAPI.GetDiscoverTvLanguageByLanguage`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
language string

Other Parameters

Other parameters are passed through a pointer to a apiGetDiscoverTvLanguageByLanguageRequest struct via the builder pattern

Name Type Description Notes

page | float32 | | [default to 1] language2 | string | |

Return type

GetDiscoverTvLanguageByLanguage2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDiscoverTvNetworkByNetworkId

GetDiscoverTvNetworkByNetworkId2XXResponse GetDiscoverTvNetworkByNetworkId(ctx, networkId).Page(page).Language(language).Execute()

Discover TV shows by network

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	networkId := "1" // string | 
	page := float32(1) // float32 |  (optional) (default to 1)
	language := "en" // string |  (optional)

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.SearchAPI.GetDiscoverTvNetworkByNetworkId(context.Background(), networkId).Page(page).Language(language).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.GetDiscoverTvNetworkByNetworkId``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetDiscoverTvNetworkByNetworkId`: GetDiscoverTvNetworkByNetworkId2XXResponse
	fmt.Fprintf(os.Stdout, "Response from `SearchAPI.GetDiscoverTvNetworkByNetworkId`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
networkId string

Other Parameters

Other parameters are passed through a pointer to a apiGetDiscoverTvNetworkByNetworkIdRequest struct via the builder pattern

Name Type Description Notes

page | float32 | | [default to 1] language | string | |

Return type

GetDiscoverTvNetworkByNetworkId2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDiscoverTvUpcoming

GetDiscoverTv2XXResponse GetDiscoverTvUpcoming(ctx).Page(page).Language(language).Execute()

Discover Upcoming TV shows

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	page := float32(1) // float32 |  (optional) (default to 1)
	language := "en" // string |  (optional)

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.SearchAPI.GetDiscoverTvUpcoming(context.Background()).Page(page).Language(language).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.GetDiscoverTvUpcoming``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetDiscoverTvUpcoming`: GetDiscoverTv2XXResponse
	fmt.Fprintf(os.Stdout, "Response from `SearchAPI.GetDiscoverTvUpcoming`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetDiscoverTvUpcomingRequest struct via the builder pattern

Name Type Description Notes
page float32 [default to 1]
language string

Return type

GetDiscoverTv2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDiscoverWatchlist

GetUserWatchlist2XXResponse GetDiscoverWatchlist(ctx).Page(page).Execute()

Get the Plex watchlist.

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	page := float32(1) // float32 |  (optional) (default to 1)

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.SearchAPI.GetDiscoverWatchlist(context.Background()).Page(page).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.GetDiscoverWatchlist``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetDiscoverWatchlist`: GetUserWatchlist2XXResponse
	fmt.Fprintf(os.Stdout, "Response from `SearchAPI.GetDiscoverWatchlist`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetDiscoverWatchlistRequest struct via the builder pattern

Name Type Description Notes
page float32 [default to 1]

Return type

GetUserWatchlist2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSearch

GetSearch2XXResponse GetSearch(ctx).Query(query).Page(page).Language(language).Execute()

Search for movies, TV shows, or people

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	query := "Mulan" // string | 
	page := float32(1) // float32 |  (optional) (default to 1)
	language := "en" // string |  (optional)

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.SearchAPI.GetSearch(context.Background()).Query(query).Page(page).Language(language).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.GetSearch``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetSearch`: GetSearch2XXResponse
	fmt.Fprintf(os.Stdout, "Response from `SearchAPI.GetSearch`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetSearchRequest struct via the builder pattern

Name Type Description Notes
query string
page float32 [default to 1]
language string

Return type

GetSearch2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSearchCompany

GetSearchCompany2XXResponse GetSearchCompany(ctx).Query(query).Page(page).Execute()

Search for companies

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	query := "Disney" // string | 
	page := float32(1) // float32 |  (optional) (default to 1)

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.SearchAPI.GetSearchCompany(context.Background()).Query(query).Page(page).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.GetSearchCompany``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetSearchCompany`: GetSearchCompany2XXResponse
	fmt.Fprintf(os.Stdout, "Response from `SearchAPI.GetSearchCompany`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetSearchCompanyRequest struct via the builder pattern

Name Type Description Notes
query string
page float32 [default to 1]

Return type

GetSearchCompany2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSearchKeyword

GetSearchKeyword2XXResponse GetSearchKeyword(ctx).Query(query).Page(page).Execute()

Search for keywords

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	query := "christmas" // string | 
	page := float32(1) // float32 |  (optional) (default to 1)

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.SearchAPI.GetSearchKeyword(context.Background()).Query(query).Page(page).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.GetSearchKeyword``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetSearchKeyword`: GetSearchKeyword2XXResponse
	fmt.Fprintf(os.Stdout, "Response from `SearchAPI.GetSearchKeyword`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetSearchKeywordRequest struct via the builder pattern

Name Type Description Notes
query string
page float32 [default to 1]

Return type

GetSearchKeyword2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListDiscoverGenresliderMovie

[]ListDiscoverGenresliderMovie2XXResponseInner ListDiscoverGenresliderMovie(ctx).Language(language).Execute()

Get genre slider data for movies

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	language := "en" // string |  (optional)

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.SearchAPI.ListDiscoverGenresliderMovie(context.Background()).Language(language).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.ListDiscoverGenresliderMovie``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListDiscoverGenresliderMovie`: []ListDiscoverGenresliderMovie2XXResponseInner
	fmt.Fprintf(os.Stdout, "Response from `SearchAPI.ListDiscoverGenresliderMovie`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiListDiscoverGenresliderMovieRequest struct via the builder pattern

Name Type Description Notes
language string

Return type

[]ListDiscoverGenresliderMovie2XXResponseInner

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListDiscoverGenresliderTv

[]ListDiscoverGenresliderMovie2XXResponseInner ListDiscoverGenresliderTv(ctx).Language(language).Execute()

Get genre slider data for TV series

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	language := "en" // string |  (optional)

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.SearchAPI.ListDiscoverGenresliderTv(context.Background()).Language(language).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.ListDiscoverGenresliderTv``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListDiscoverGenresliderTv`: []ListDiscoverGenresliderMovie2XXResponseInner
	fmt.Fprintf(os.Stdout, "Response from `SearchAPI.ListDiscoverGenresliderTv`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiListDiscoverGenresliderTvRequest struct via the builder pattern

Name Type Description Notes
language string

Return type

[]ListDiscoverGenresliderMovie2XXResponseInner

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]