opensource/Jackett
3
0
Fork 0
mirror of https://github.com/Jackett/Jackett.git synced 2026-10-31 19:26:03 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
master
Jackett/docs/schema.md
T

126 KiB
Raw Permalink Blame History

Cardigann indexer definition Schema

Cardigann

Schema for Jackett Cardigann YAML indexer definitions. See the Definition-format page on the Jackett wiki for examples.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Access Restrictions Defined In
Cannot be instantiated Yes Unknown status Unknown identifiability Forbidden Allowed none schema.json

Cardigann indexer definition Type

object (Cardigann indexer definition)

Cardigann indexer definition Definitions

Definitions group SchemaRoot

Reference this group by using

{"$ref":"Cardigann#/definitions/SchemaRoot"}
Property Type Required Nullable Defined by
id string Required cannot be null Cardigann indexer definition
replaces array Optional cannot be null Cardigann indexer definition
name string Required cannot be null Cardigann indexer definition
description string Required cannot be null Cardigann indexer definition
language string Required cannot be null Cardigann indexer definition
type string Required cannot be null Cardigann indexer definition
encoding string Required cannot be null Cardigann indexer definition
followredirect boolean Optional cannot be null Cardigann indexer definition
testlinktorrent boolean Optional cannot be null Cardigann indexer definition
requestDelay number Optional cannot be null Cardigann indexer definition
links array Required cannot be null Cardigann indexer definition
legacylinks array Optional cannot be null Cardigann indexer definition
certificates array Optional cannot be null Cardigann indexer definition
caps Merged Required cannot be null Cardigann indexer definition
settings array Optional cannot be null Cardigann indexer definition
login object Optional cannot be null Cardigann indexer definition
search Merged Required cannot be null Cardigann indexer definition
download object Optional cannot be null Cardigann indexer definition

id

Internal name of the indexer. Must be unique. Usually the site name in lower case without special characters or spaces. Used in the Torznab, download and search URLs and in the indexer config file name.

id

id Type

string (ID)

replaces

Old indexer IDs this definition replaces. Keeps existing configs working after an ID rename. Maintainer use only.

replaces

replaces Type

string[] (Replaced ID)

replaces Constraints

unique items: all items in this array must be unique. Duplicates are not allowed.

name

Display name of the tracker.

name

name Type

string (Name)

description

Short description shown in the tooltip on the add-indexer page and in the config panel. Usually sourced from opentrackers.org when available.

description

description Type

string (Description)

language

Language code of the main language used on the tracker, usually from the site's <html lang> attribute.

language

language Type

string (Language)

language Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"af"
"af-ZA"
"ar"
"ar-AE"
"ar-BH"
"ar-DZ"
"ar-EG"
"ar-IQ"
"ar-JO"
"ar-KW"
"ar-LB"
"ar-LY"
"ar-MA"
"ar-OM"
"ar-QA"
"ar-SA"
"ar-SY"
"ar-TN"
"ar-YE"
"az"
"az-AZ"
"be"
"be-BY"
"bg"
"bg-BG"
"bs-BA"
"ca"
"ca-ES"
"cs"
"cs-CZ"
"cy"
"cy-GB"
"da"
"da-DK"
"de"
"de-AT"
"de-CH"
"de-DE"
"de-LI"
"de-LU"
"dv"
"dv-MV"
"el"
"el-GR"
"en"
"en-AU"
"en-BZ"
"en-CA"
"en-CB"
"en-GB"
"en-IE"
"en-JM"
"en-NZ"
"en-PH"
"en-TT"
"en-US"
"en-ZA"
"en-ZW"
"eo"
"es"
"es-AR"
"es-BO"
"es-CL"
"es-CO"
"es-CR"
"es-DO"
"es-EC"
"es-ES"
"es-GT"
"es-HN"
"es-MX"
"es-NI"
"es-PA"
"es-PE"
"es-PR"
"es-PY"
"es-SV"
"es-UY"
"es-VE"
"et"
"et-EE"
"eu"
"eu-ES"
"fa"
"fa-IR"
"fi"
"fi-FI"
"fo"
"fo-FO"
"fr"
"fr-BE"
"fr-CA"
"fr-CH"
"fr-FR"
"fr-LU"
"fr-MC"
"gl"
"gl-ES"
"gu"
"gu-IN"
"he"
"he-IL"
"hi"
"hi-IN"
"hr"
"hr-BA"
"hr-HR"
"hu"
"hu-HU"
"hy"
"hy-AM"
"id"
"id-ID"
"is"
"is-IS"
"it"
"it-CH"
"it-IT"
"ja"
"ja-JP"
"ka"
"ka-GE"
"kk"
"kk-KZ"
"kn"
"kn-IN"
"ko"
"ko-KR"
"kok"
"kok-IN"
"ky"
"ky-KG"
"lt"
"lt-LT"
"lv"
"lv-LV"
"mi"
"mi-NZ"
"mk"
"mk-MK"
"mn"
"mn-MN"
"mr"
"mr-IN"
"ms"
"ms-BN"
"ms-MY"
"mt"
"mt-MT"
"nb"
"nb-NO"
"nl"
"nl-BE"
"nl-NL"
"nn-NO"
"ns"
"ns-ZA"
"pa"
"pa-IN"
"pl"
"pl-PL"
"ps"
"ps-AR"
"pt"
"pt-BR"
"pt-PT"
"qu"
"qu-BO"
"qu-EC"
"qu-PE"
"ro"
"ro-RO"
"ru"
"ru-RU"
"sa"
"sa-IN"
"se"
"se-FI"
"se-NO"
"se-SE"
"sk"
"sk-SK"
"sl"
"sl-SI"
"sq"
"sq-AL"
"sr-BA"
"sr-SP"
"sv"
"sv-FI"
"sv-SE"
"sw"
"sw-KE"
"syr"
"syr-SY"
"ta"
"ta-IN"
"te"
"te-IN"
"th"
"th-TH"
"tl"
"tl-PH"
"tn"
"tn-ZA"
"tr"
"tr-TR"
"tt"
"tt-RU"
"ts"
"uk"
"uk-UA"
"ur"
"ur-PK"
"uz"
"uz-UZ"
"vi"
"vi-VN"
"xh"
"xh-ZA"
"zh"
"zh-CN"
"zh-HK"
"zh-MO"
"zh-SG"
"zh-TW"
"zu"
"zu-ZA"

type

public: no registration required. semi-private: registration required but always open. private: invite or application needed.

type

type Type

string (Type)

type Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"public"
"semi-private"
"private"

encoding

Character encoding of the site, usually from its tag.

encoding

encoding Type

string (Encoding)

followredirect

Automatically update the site URL when the site redirects to a different domain. Default: false.

followredirect

followredirect Type

boolean (Follow redirect)

testlinktorrent

Pre-test the .torrent download when grabbing. Set to false for sites that reject two GET requests for the same .torrent in sequence. Indexers that support fallback downloading need true. Default: true.

testlinktorrent

testlinktorrent Type

boolean (Test link torrent)

requestDelay

Seconds to wait between requests to the site. Use for sites that temporarily block clients that exceed a request rate.

requestDelay

requestDelay Type

number (Request delay)

links

Known site URLs. The first is the default. Each must end with /.

links

links Type

string[] (Link)

links Constraints

unique items: all items in this array must be unique. Duplicates are not allowed.

legacylinks

Old site URLs that no longer work. A configured legacy URL is replaced automatically with the first entry in links.

legacylinks

legacylinks Type

string[] (Legacy link)

legacylinks Constraints

unique items: all items in this array must be unique. Duplicates are not allowed.

certificates

SHA-1 fingerprints of untrusted HTTPS certificates (self-signed, expired, etc.) to accept anyway. Rarely needed.

certificates

certificates Type

string[] (Certificate fingerprint)

certificates Constraints

unique items: all items in this array must be unique. Duplicates are not allowed.

caps

Capabilities of the indexer: category mappings and supported Torznab search modes.

caps

caps Type

object (Caps)

one (and only one) of

settings

Config options shown for the indexer. If omitted, username and password are used. Set to [] for public trackers that need no settings.

settings

settings Type

object[] (SettingsField)

login

How Jackett logs in to the tracker. Omit for sites that need no login.

login

login Type

object (Login)

search

How to build search requests and parse torrent results from the response.

search

search Type

object (Search)

one (and only one) of

download

Needed only when the download link cannot be taken directly from the search results, the download must be a POST, or another page must be requested first.

download

download Type

object (DownloadBlock)

Definitions group Caps

Reference this group by using

{"$ref":"Cardigann#/definitions/Caps"}
Property Type Required Nullable Defined by
categories object Optional cannot be null Cardigann indexer definition
categorymappings array Optional cannot be null Cardigann indexer definition
modes object Required cannot be null Cardigann indexer definition
allowrawsearch boolean Optional cannot be null Cardigann indexer definition
allowtvsearchimdb boolean Optional cannot be null Cardigann indexer definition

categories

Simple mapping of tracker category ID to Newznab category. Use either this or categorymappings.

categories

categories Type

object (Categories (Caps))

categorymappings

List of tracker-to-Newznab category mappings. Use either this or categories.

categorymappings

categorymappings Type

object[] (CategoryMapping)

categorymappings Constraints

unique items: all items in this array must be unique. Duplicates are not allowed.

modes

Torznab search modes and the query parameters the tracker supports for each. Most apps calling Jackett depend on these being correct.

modes

modes Type

object (Modes)

allowrawsearch

Enable raw search. See Jackett issue 8246.

allowrawsearch

allowrawsearch Type

boolean (Allow raw search)

allowtvsearchimdb

Allow imdbid in tv-search. See Jackett issue 16412.

allowtvsearchimdb

allowtvsearchimdb Type

boolean (Allow TV search by IMDb ID)

Definitions group CategoryMapping

Reference this group by using

{"$ref":"Cardigann#/definitions/CategoryMapping"}
Property Type Required Nullable Defined by
id Merged Required cannot be null Cardigann indexer definition
cat string Required cannot be null Cardigann indexer definition
desc string Optional cannot be null Cardigann indexer definition
default boolean Optional cannot be null Cardigann indexer definition

id

Tracker-specific category ID. Can be a number or a string.

id

id Type

merged type (ID)

one (and only one) of

cat

Predefined Newznab/Torznab category name. See the Jackett-Categories wiki page.

cat

cat Type

string (IndexerCategories)

cat Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"Console"
"Console/NDS"
"Console/PSP"
"Console/Wii"
"Console/XBox"
"Console/XBox 360"
"Console/Wiiware"
"Console/XBox 360 DLC"
"Console/PS3"
"Console/Other"
"Console/3DS"
"Console/PS Vita"
"Console/WiiU"
"Console/XBox One"
"Console/PS4"
"Movies"
"Movies/Foreign"
"Movies/Other"
"Movies/SD"
"Movies/HD"
"Movies/UHD"
"Movies/BluRay"
"Movies/3D"
"Movies/DVD"
"Movies/WEB-DL"
"Audio"
"Audio/MP3"
"Audio/Video"
"Audio/Audiobook"
"Audio/Lossless"
"Audio/Other"
"Audio/Foreign"
"PC"
"PC/0day"
"PC/ISO"
"PC/Mac"
"PC/Mobile-Other"
"PC/Games"
"PC/Mobile-iOS"
"PC/Mobile-Android"
"TV"
"TV/WEB-DL"
"TV/Foreign"
"TV/SD"
"TV/HD"
"TV/UHD"
"TV/Other"
"TV/Sport"
"TV/Anime"
"TV/Documentary"
"XXX"
"XXX/DVD"
"XXX/WMV"
"XXX/XviD"
"XXX/x264"
"XXX/UHD"
"XXX/Pack"
"XXX/ImageSet"
"XXX/Other"
"XXX/SD"
"XXX/WEB-DL"
"Books"
"Books/Mags"
"Books/EBook"
"Books/Comics"
"Books/Technical"
"Books/Other"
"Books/Foreign"
"Other"
"Other/Misc"
"Other/Hashed"

desc

Tracker category name. If set, it is used for a 1:1 mapping between tracker and Newznab categories.

desc

desc Type

string (Description)

default

Use this category when the search query has no categories. Default: false.

default

default Type

boolean (Default)

Definitions group Modes

Reference this group by using

{"$ref":"Cardigann#/definitions/Modes"}
Property Type Required Nullable Defined by
search array Required cannot be null Cardigann indexer definition
tv-search array Optional cannot be null Cardigann indexer definition
movie-search array Optional cannot be null Cardigann indexer definition
music-search array Optional cannot be null Cardigann indexer definition
book-search array Optional cannot be null Cardigann indexer definition

search

Parameters for basic search. q is the minimum and is required.

search

search Type

string[] (Search parameter)

search Constraints

unique items: all items in this array must be unique. Duplicates are not allowed.

tv-search

Parameters supported for TV search. Only list those the tracker can search with.

tv-search

tv-search Type

string[] (Search parameter)

tv-search Constraints

unique items: all items in this array must be unique. Duplicates are not allowed.

movie-search

Parameters supported for movie search. Only list those the tracker can search with.

movie-search

movie-search Type

string[] (Search parameter)

movie-search Constraints

unique items: all items in this array must be unique. Duplicates are not allowed.

music-search

Parameters supported for music search. Only list those the tracker can search with.

music-search

music-search Type

string[] (Search parameter)

music-search Constraints

unique items: all items in this array must be unique. Duplicates are not allowed.

book-search

Parameters supported for book search. Only list those the tracker can search with.

book-search

book-search Type

string[] (Search parameter)

book-search Constraints

unique items: all items in this array must be unique. Duplicates are not allowed.

Definitions group SettingsField

Reference this group by using

{"$ref":"Cardigann#/definitions/SettingsField"}
Property Type Required Nullable Defined by
name string Required cannot be null Cardigann indexer definition
label string Optional cannot be null Cardigann indexer definition
type string Required cannot be null Cardigann indexer definition
default Merged Optional cannot be null Cardigann indexer definition
options object Optional cannot be null Cardigann indexer definition
defaults array Optional cannot be null Cardigann indexer definition

name

Internal variable name. Referenced in templates as .Config..

name

name Type

string (Name)

label

Display name shown on the config page.

label

label Type

string (Label)

type

Input type. password masks the input. The info_* types show a predefined info box (category_8000, cookie, FlareSolverr, useragent) and need no label.

type

type Type

string (Type)

type Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"info"
"text"
"password"
"checkbox"
"select"
"multi-select"
"info_category_8000"
"info_cookie"
"info_flaresolverr"
"info_useragent"

default

Default value. For checkbox, true ticks it (unticked by default). For info, the text to display. For select, the default option key.

default

default Type

merged type (Default)

one (and only one) of

options

Select options as key: display-name pairs.

options

options Type

object (Options)

defaults

Default selected option keys for a multi-select.

defaults

defaults Type

string[] (Option key)

Definitions group Login

Reference this group by using

{"$ref":"Cardigann#/definitions/Login"}
Property Type Required Nullable Defined by
method string Optional cannot be null Cardigann indexer definition
cookies array Optional cannot be null Cardigann indexer definition
path string Optional cannot be null Cardigann indexer definition
submitpath string Optional cannot be null Cardigann indexer definition
form string Optional cannot be null Cardigann indexer definition
captcha object Optional cannot be null Cardigann indexer definition
inputs object Optional cannot be null Cardigann indexer definition
selectors boolean Optional cannot be null Cardigann indexer definition
selectorinputs object Optional cannot be null Cardigann indexer definition
getselectorinputs object Optional cannot be null Cardigann indexer definition
error array Optional cannot be null Cardigann indexer definition
test object Optional cannot be null Cardigann indexer definition
headers object Optional cannot be null Cardigann indexer definition

method

post: send inputs as an HTTP POST. get: same, using HTTP GET. form: fetch path, extract the HTML form (handles CSRF tokens and captchas), then POST it. cookie: use the configured cookie. oneurl: legacy, added for the removed beyond-hd-oneurl indexer; no definition uses it.

method

method Type

string (Method)

method Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"form"
"post"
"cookie"
"get"
"oneurl"

cookies

Cookies sent with the post login request.

cookies

cookies Type

string[] (Cookie)

path

Login target. For post/get it is the request URL. For form it is the page containing the login form.

path

path Type

string (Path)

submitpath

Form login only. URL to POST to, when it differs from the form's action attribute.

submitpath

submitpath Type

string (Submit path)

form

Form login only. Selector for the HTML form element. Default: form.

form

form Type

string (Form)

captcha

Captcha handling for form logins. Google ReCaptcha and simplecaptcha are detected automatically and need no captcha block.

captcha

captcha Type

object (CaptchaBlock)

inputs

Login parameters, for example, username: "{{ .Config.username }}". Fixed values are allowed.

inputs

inputs Type

object (Inputs (Login))

selectors

Form login only. If true, the keys in inputs are treated as CSS selectors. Only needed for dynamic input names (very rare).

selectors

selectors Type

boolean (Selectors)

selectorinputs

Form login only. Input values taken from the login page with selectors, for example, a CSRF token hidden in JavaScript.

selectorinputs

selectorinputs Type

object (Selector inputs)

getselectorinputs

Form login only. Like selectorinputs, but sent in the query string instead of the POST body.

getselectorinputs

getselectorinputs Type

object (GET selector inputs)

error

Selectors checked on the login response. If one matches, the login failed and the matched text is shown as the error.

error

error Type

object[] (ErrorBlock)

test

Page requested after login to confirm the session is valid. A redirect, or no selector match, means the login failed. Also used during searches to detect an expired session and re-login.

test

test Type

object (PageTestBlock)

headers

Extra HTTP headers sent with login requests. If omitted, search headers are used.

headers

headers Type

object (Headers (Login))

Definitions group PageTestBlock

Reference this group by using

{"$ref":"Cardigann#/definitions/PageTestBlock"}
Property Type Required Nullable Defined by
path string Required cannot be null Cardigann indexer definition
selector string Required cannot be null Cardigann indexer definition

path

Page to request, typically the home page or the search page.

path

path Type

string (Path)

selector

Selector that must match on a logged-in page. Required if the site shows a login form instead of redirecting.

selector

selector Type

string (Selector)

Definitions group CaptchaBlock

Reference this group by using

{"$ref":"Cardigann#/definitions/CaptchaBlock"}
Property Type Required Nullable Defined by
type string Required cannot be null Cardigann indexer definition
selector string Required cannot be null Cardigann indexer definition
input string Required cannot be null Cardigann indexer definition

type

Captcha type: image or text.

type

type Type

string (Type)

type Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"image"
"text"

selector

Selector for the captcha HTML element.

selector

selector Type

string (Selector)

input

Name of the form field that receives the captcha value.

input

input Type

string (Input)

Definitions group ErrorBlock

Reference this group by using

{"$ref":"Cardigann#/definitions/ErrorBlock"}
Property Type Required Nullable Defined by
path string Optional cannot be null Cardigann indexer definition
selector string Required cannot be null Cardigann indexer definition
message Merged Optional cannot be null Cardigann indexer definition

path

Only check responses from this path.

path

path Type

string (Path)

selector

If this selector matches, the request failed.

selector

selector Type

string (Selector)

message

Extracts a value from a response using a CSS selector (HTML) or path (JSON/XML), then applies case, remove and filters.

message

message Type

object (SelectorBlock)

all of

Definitions group SelectorBlock

Reference this group by using

{"$ref":"Cardigann#/definitions/SelectorBlock"}
Property Type Required Nullable Defined by
selector string Optional cannot be null Cardigann indexer definition
attribute string Optional cannot be null Cardigann indexer definition
optional boolean Optional cannot be null Cardigann indexer definition
default Merged Optional cannot be null Cardigann indexer definition
case object Optional cannot be null Cardigann indexer definition
remove string Optional cannot be null Cardigann indexer definition
text Merged Optional cannot be null Cardigann indexer definition
filters array Optional cannot be null Cardigann indexer definition

selector

CSS selector for HTML, or path for JSON/XML. :has(), :not() and :contains() are supported. In JSON, $ refers to the root object and a .. prefix reads from the row instead of the rows attribute subset.

selector

selector Type

string (Selector)

attribute

Take the value of this attribute (for example, href) instead of the element text.

attribute

attribute Type

string (Attribute)

optional

Do not fail if the selector does not match. Use with default.

optional

optional Type

boolean (Optional)

default

Value used when an optional selector does not match. Templates are allowed, for example, "{{ .Result.title_default }}".

default

default Type

merged type (Default)

one (and only one) of

case

Selector: value pairs. The value of the first matching selector is used. "*" matches anything. Common for downloadvolumefactor and uploadvolumefactor.

case

case Type

object (Case (SelectorBlock))

remove

Selector for elements to remove before reading the text. Removed elements are gone for all later fields, so put fields using remove last.

remove

remove Type

string (Remove)

text

Fixed value, or a template. Used instead of selector, such as for minimumratio and minimumseedtime.

text

text Type

merged type (Text)

one (and only one) of

filters

Filters applied to the extracted value, in order.

filters

filters Type

object[] (FilterBlock)

Definitions group Search

Reference this group by using

{"$ref":"Cardigann#/definitions/Search"}
Property Type Required Nullable Defined by
path string Optional cannot be null Cardigann indexer definition
paths array Optional cannot be null Cardigann indexer definition
allowEmptyInputs boolean Optional cannot be null Cardigann indexer definition
inputs object Optional cannot be null Cardigann indexer definition
headers object Optional cannot be null Cardigann indexer definition
keywordsfilters array Optional cannot be null Cardigann indexer definition
error array Optional cannot be null Cardigann indexer definition
preprocessingfilters array Optional cannot be null Cardigann indexer definition
rows object Required cannot be null Cardigann indexer definition
fields Merged Required cannot be null Cardigann indexer definition

path

Single search path. Shorthand for paths with one entry.

path

path Type

string (Path)

paths

Search requests. Usually one. Some trackers need separate pages, for example, for porn or scene releases.

paths

paths Type

object[] (SearchPathBlock)

allowEmptyInputs

Send inputs whose value resolves to empty. By default such key/value pairs are dropped. Default: false.

allowEmptyInputs

allowEmptyInputs Type

boolean (Allow empty inputs)

inputs

HTTP arguments used by all paths. $raw is appended to the argument list without escaping (only variables are escaped).

inputs

inputs Type

object (Inputs (Search))

headers

Extra HTTP headers sent with search requests.

headers

headers Type

object (Headers (Search))

keywordsfilters

Filters applied to the search keywords. The result is available as .Keywords.

keywordsfilters

keywordsfilters Type

object[] (FilterBlock)

error

Selectors checked on the search response. Same syntax as the login error block.

error

error Type

object[] (ErrorBlock)

preprocessingfilters

Filters applied to the raw response before parsing.

preprocessingfilters

preprocessingfilters Type

object[] (FilterBlock)

rows

Selects the result rows. Each row is then parsed with the fields block.

rows

rows Type

object (RowsBlock)

fields

Fields extracted from each result row. Names starting with _ are working fields for use in templates via .Result..

fields

fields Type

object (FieldsBlock)

one (and only one) of

Definitions group SearchPathBlock

Reference this group by using

{"$ref":"Cardigann#/definitions/SearchPathBlock"}
Property Type Required Nullable Defined by
path string Required cannot be null Cardigann indexer definition
method string Optional cannot be null Cardigann indexer definition
followredirect boolean Optional cannot be null Cardigann indexer definition
categories array Optional cannot be null Cardigann indexer definition
inputs object Optional cannot be null Cardigann indexer definition
inheritinputs boolean Optional cannot be null Cardigann indexer definition
queryseparator string Optional cannot be null Cardigann indexer definition
response object Optional cannot be null Cardigann indexer definition

path

Search URL path. Templates and conditionals are allowed.

path

path Type

string (Path)

method

HTTP method: get or post. Templates are allowed. Default: get.

method

method Type

string (Method)

followredirect

Follow redirects on search requests. If true, set a selector in login.test. Default: false.

followredirect

followredirect Type

boolean (Follow redirect)

categories

Only use this path if the search includes at least one of these tracker categories. A leading "!" inverts the match.

categories

categories Type

an array of merged types (Tracker category)

inputs

Extra HTTP arguments for this path only.

inputs

inputs Type

object (Inputs (SearchPathBlock))

inheritinputs

Use the search-level inputs as the base for this path's inputs. Default: true.

inheritinputs

inheritinputs Type

boolean (Inherit inputs)

queryseparator

Query string separator. Default: &.

queryseparator

queryseparator Type

string (Query separator)

response

Response type for non-HTML search results. Omit for HTML, which is the default.

response

response Type

object (ResponseBlock)

Definitions group ResponseBlock

Reference this group by using

{"$ref":"Cardigann#/definitions/ResponseBlock"}
Property Type Required Nullable Defined by
type string Required cannot be null Cardigann indexer definition
noResultsMessage string Optional cannot be null Cardigann indexer definition

type

json or xml.

type

type Type

string (Type)

type Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"json"
"xml"

noResultsMessage

If the response contains this text, or is empty and this is an empty string, return zero results instead of an error. For sites that do not return an empty object or a zero count.

noResultsMessage

noResultsMessage Type

string (No results message)

Definitions group RowsBlock

Reference this group by using

{"$ref":"Cardigann#/definitions/RowsBlock"}
Property Type Required Nullable Defined by
after integer Optional cannot be null Cardigann indexer definition
dateheaders Merged Optional cannot be null Cardigann indexer definition
selector string Optional cannot be null Cardigann indexer definition
attribute string Optional cannot be null Cardigann indexer definition
optional boolean Optional cannot be null Cardigann indexer definition
multiple boolean Optional cannot be null Cardigann indexer definition
missingAttributeEqualsNoResults boolean Optional cannot be null Cardigann indexer definition
case object Optional cannot be null Cardigann indexer definition
remove string Optional cannot be null Cardigann indexer definition
text Merged Optional cannot be null Cardigann indexer definition
filters array Optional cannot be null Cardigann indexer definition
count Merged Optional cannot be null Cardigann indexer definition

after

Row merging. Merge this many following elements into each row, for sites that use several elements per torrent (for example, collapsed rows).

after

after Type

integer (After)

dateheaders

Extracts a value from a response using a CSS selector (HTML) or path (JSON/XML), then applies case, remove and filters.

dateheaders

dateheaders Type

object (SelectorBlock)

all of

selector

Selector for the result rows. For JSON, $ refers to the root object.

selector

selector Type

string (Selector)

attribute

JSON/XML only. Sub-element holding the torrents, when they are nested in each row.

attribute

attribute Type

string (Attribute)

optional

Do not fail if the selector does not match.

optional

optional Type

boolean (Optional)

multiple

JSON/XML only. Each row holds several torrents (for example, one title with several releases).

multiple

multiple Type

boolean (Multiple)

missingAttributeEqualsNoResults

JSON/XML only. Return zero results instead of an error when attribute is missing.

missingAttributeEqualsNoResults

missingAttributeEqualsNoResults Type

boolean (Missing attribute equals no results)

case

Selector: value pairs. The value of the first matching selector is used.

case

case Type

object (Case (RowsBlock))

remove

Selector for elements to remove from each row.

remove

remove Type

string (Remove)

text

Fixed value, or a template.

text

text Type

merged type (Text)

one (and only one) of

filters

Row filters, for example, andmatch or strdump.

filters

filters Type

object[] (RowFilterBlock)

count

Extracts a value from a response using a CSS selector (HTML) or path (JSON/XML), then applies case, remove and filters.

count

count Type

object (SelectorBlock)

all of

Definitions group FieldsBlock

Reference this group by using

{"$ref":"Cardigann#/definitions/FieldsBlock"}
Property Type Required Nullable Defined by
^_[A-Za-z0-9-_]*$ Merged Optional cannot be null Cardigann indexer definition
^((title|description)\|(append))?$ Merged Optional cannot be null Cardigann indexer definition
^((category|categorydesc)\|(noappend|append))?$ Merged Optional cannot be null Cardigann indexer definition
^(download|magnet|infohash|details|comments|title|description|category|categorydesc|size|leechers|seeders|date|files|grabs|downloadvolumefactor|uploadvolumefactor|minimumratio|minimumseedtime|imdb|imdbid|tmdbid|rageid|tvdbid|tvmazeid|traktid|doubanid|poster|genre|year|author|booktitle|publisher|album|artist|label|track)(_([A-Za-z0-9_])*)?$ Merged Optional cannot be null Cardigann indexer definition

Pattern: ^_[A-Za-z0-9-_]*$

Extracts a value from a response using a CSS selector (HTML) or path (JSON/XML), then applies case, remove and filters.

^_[A-Za-z0-9-_]*$

^_[A-Za-z0-9-_]*$ Type

object (SelectorBlock)

all of

Pattern: ^((title|description)\|(append))?$

Extracts a value from a response using a CSS selector (HTML) or path (JSON/XML), then applies case, remove and filters.

^((title|description)\|(append))?$

^((title|description)\|(append))?$ Type

object (SelectorBlock)

all of

Pattern: ^((category|categorydesc)\|(noappend|append))?$

Extracts a value from a response using a CSS selector (HTML) or path (JSON/XML), then applies case, remove and filters.

^((category|categorydesc)\|(noappend|append))?$

^((category|categorydesc)\|(noappend|append))?$ Type

object (SelectorBlock)

all of

Pattern: ^(download|magnet|infohash|details|comments|title|description|category|categorydesc|size|leechers|seeders|date|files|grabs|downloadvolumefactor|uploadvolumefactor|minimumratio|minimumseedtime|imdb|imdbid|tmdbid|rageid|tvdbid|tvmazeid|traktid|doubanid|poster|genre|year|author|booktitle|publisher|album|artist|label|track)(_([A-Za-z0-9_])*)?$

Extracts a value from a response using a CSS selector (HTML) or path (JSON/XML), then applies case, remove and filters.

^(download|magnet|infohash|details|comments|title|description|category|categorydesc|size|leechers|seeders|date|files|grabs|downloadvolumefactor|uploadvolumefactor|minimumratio|minimumseedtime|imdb|imdbid|tmdbid|rageid|tvdbid|tvmazeid|traktid|doubanid|poster|genre|year|author|booktitle|publisher|album|artist|label|track)(_([A-Za-z0-9_])*)?$

^(download|magnet|infohash|details|comments|title|description|category|categorydesc|size|leechers|seeders|date|files|grabs|downloadvolumefactor|uploadvolumefactor|minimumratio|minimumseedtime|imdb|imdbid|tmdbid|rageid|tvdbid|tvmazeid|traktid|doubanid|poster|genre|year|author|booktitle|publisher|album|artist|label|track)(_([A-Za-z0-9_])*)?$ Type

object (SelectorBlock)

all of

Definitions group DownloadBlock

Reference this group by using

{"$ref":"Cardigann#/definitions/DownloadBlock"}
Property Type Required Nullable Defined by
method string Optional cannot be null Cardigann indexer definition
before Merged Optional cannot be null Cardigann indexer definition
selectors array Optional cannot be null Cardigann indexer definition
infohash object Optional cannot be null Cardigann indexer definition
headers object Optional cannot be null Cardigann indexer definition

method

HTTP method for the download: get or post. Default: get.

method

method Type

string (Method)

before

HTTP request sent before the download (for example, a 'thank you' page).

before

before Type

object (BeforeBlock)

one (and only one) of

selectors

If set, the search result download URL is fetched and parsed as HTML, and the first selector gives the actual download URL. Later selectors are fallbacks.

selectors

selectors Type

object[] (SelectorBlock)

infohash

Builds a magnet URI from an infohash and title. Public and semi-private indexers only: private sites usually require their own tracker and have DHT disabled.

infohash

infohash Type

object (InfoHashBlock)

headers

Extra HTTP headers sent with download requests.

headers

headers Type

object (Headers (DownloadBlock))

Definitions group BeforeBlock

Reference this group by using

{"$ref":"Cardigann#/definitions/BeforeBlock"}
Property Type Required Nullable Defined by
path string Optional cannot be null Cardigann indexer definition
pathselector object Optional cannot be null Cardigann indexer definition
method string Optional cannot be null Cardigann indexer definition
inputs object Optional cannot be null Cardigann indexer definition
queryseparator string Optional cannot be null Cardigann indexer definition

path

Request target.

path

path Type

string (Path)

pathselector

Selector applied to the download page to get the download URL, hash or title.

pathselector

pathselector Type

object (SelectorField)

method

HTTP method: get or post.

method

method Type

string (Method)

inputs

HTTP arguments sent with the request, for example, id: "{{ .DownloadUri.Query.id }}".

inputs

inputs Type

object (Inputs (BeforeBlock))

queryseparator

Query string separator. Default: &.

queryseparator

queryseparator Type

string (Query separator)

Definitions group InfoHashBlock

Reference this group by using

{"$ref":"Cardigann#/definitions/InfoHashBlock"}
Property Type Required Nullable Defined by
hash object Optional cannot be null Cardigann indexer definition
title object Optional cannot be null Cardigann indexer definition
usebeforeresponse boolean Optional cannot be null Cardigann indexer definition

hash

Selector applied to the download page to get the download URL, hash or title.

hash

hash Type

object (SelectorField)

title

Selector applied to the download page to get the download URL, hash or title.

title

title Type

object (SelectorField)

usebeforeresponse

Take hash and title from the page returned by the before request instead of the search result download link. Default: false.

usebeforeresponse

usebeforeresponse Type

boolean (Use before response)

Definitions group SelectorField

Reference this group by using

{"$ref":"Cardigann#/definitions/SelectorField"}
Property Type Required Nullable Defined by
selector string Optional cannot be null Cardigann indexer definition
attribute string Optional cannot be null Cardigann indexer definition
usebeforeresponse boolean Optional cannot be null Cardigann indexer definition
filters array Optional cannot be null Cardigann indexer definition

selector

Selector for the value.

selector

selector Type

string (Selector)

attribute

Take the value of this attribute (for example, href) instead of the element text.

attribute

attribute Type

string (Attribute)

usebeforeresponse

Apply the selector to the page returned by the before request instead of the search result download link. Default: false.

usebeforeresponse

usebeforeresponse Type

boolean (Use before response)

filters

Filters applied to the extracted value, in order.

filters

filters Type

object[] (FilterBlock)

Definitions group RowFilterBlock

Reference this group by using

{"$ref":"Cardigann#/definitions/RowFilterBlock"}
Property Type Required Nullable Defined by
name string Required cannot be null Cardigann indexer definition
args Merged Optional cannot be null Cardigann indexer definition

name

andmatch: only return rows containing all search words. strdump: log each row's HTML (debugging).

name

name Type

string (Name)

name Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"andmatch"
"strdump"

args

Filter arguments. For andmatch, an optional maximum title length to compare, for sites that truncate names.

args

args Type

merged type (Arguments)

one (and only one) of

Definitions group FilterBlock

Reference this group by using

{"$ref":"Cardigann#/definitions/FilterBlock"}
Property Type Required Nullable Defined by
name string Required cannot be null Cardigann indexer definition
args Merged Optional cannot be null Cardigann indexer definition

name

Filter name.

name

name Type

string (Name)

name Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"querystring"
"timeparse"
"dateparse"
"regexp"
"re_replace"
"split"
"replace"
"trim"
"prepend"
"append"
"tolower"
"toupper"
"base64decode"
"base64encode"
"urldecode"
"urlencode"
"htmldecode"
"htmlencode"
"timeago"
"reltime"
"fuzzytime"
"validfilename"
"diacritics"
"jsonjoinarray"
"hexdump"
"strdump"
"validate"

args

Filter arguments: a single value or a list, depending on the filter.

args

args Type

merged type (Arguments)

one (and only one) of

Definitions group IndexerCategories

Reference this group by using

{"$ref":"Cardigann#/definitions/IndexerCategories"}
Property Type Required Nullable Defined by
Reference in New Issue View Git Blame Copy Permalink