Overview
Addon types define the structure of Stremio addons including their manifests, descriptors, resources, and request/response handling.Manifest
The main addon manifest containing metadata and capabilities.Unique identifier for the addon
Semantic version of the addon (uses
semver::Version)Display name of the addon
Contact email for the addon developer
Description of the addon
URL to the addon logo image
URL to the addon background image
Globally supported content types (e.g.,
movie, series, anime, tv)Resources supported by the addon (catalog, meta, stream, subtitles, etc.)
Globally supported ID prefixes (e.g.,
tt, anidb, kitsu)Catalog definitions provided by the addon
Addon catalog definitions
Behavior hints for the addon
ManifestResource
Defines a resource that the addon supports. Can be in short or full format. Short format: Just a string with the resource nameResource name (e.g., “catalog”, “meta”, “stream”, “subtitles”)
Content types supported by this resource (subset of manifest types)
ID prefixes supported by this resource (subset of manifest idPrefixes)
ManifestCatalog
Defines a catalog provided by the addon.Unique identifier for the catalog
Content type (e.g.,
movie, series)Display name for the catalog
Extra properties supported by the catalog
ManifestExtra
Defines extra properties for catalogs. Can be in short or full format. Full format:Array of extra property definitions
Names of required extra properties
Names of supported extra properties
ExtraProp
Defines an extra property for catalogs.Name of the extra property
Whether this property is required
Available options for this property
Maximum number of options that can be selected
ManifestBehaviorHints
Behavior hints for the addon.Whether the addon contains adult content
Whether the addon uses P2P technology
Whether the addon is configurable
Whether configuration is required before use
Descriptor
Addon descriptor containing the manifest and transport information.The addon manifest
Base URL for accessing the addon
Addon flags
DescriptorFlags
Whether this is an official Stremio addon
Whether this addon is protected from removal
ResourcePath
Defines a resource request path.Resource type (e.g., “catalog”, “meta”, “stream”, “subtitles”)
Content type (e.g., “series”, “movie”)
Resource identifier
Extra query parameters
ExtraValue
Name of the extra parameter
Value of the extra parameter
ResourceRequest
Complete resource request with base URL and path.Base URL of the addon
Resource path
ResourceResponse
Response from an addon resource request. This is an enum with the following variants:Metas
Array of meta item previews (catalog response)
MetasDetailed
Array of detailed meta items with videos
Meta
Single detailed meta item
Streams
Array of stream objects
Subtitles
Array of subtitle objects
Addons
Array of addon descriptors
ResourceResponseCache
Resource response with caching information.Cache max age in seconds
Stale-while-revalidate time in seconds
Stale-if-error time in seconds
The actual resource response