You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
resolv/docs/structures.md

8.8 KiB

URLs

Key Description
url The deobfuscated or un-shortened URL.

Dummy data

Key Description
dummy The dummy data.

Video

Key Description
title Title of the video.
videos A list of all available video files.

The list of videos can contain multiple dictionaries, each of which has the following fields:

Key Description
url URL of the video file.
method The method to be used for retrieving this URL (either GET or POST).
postdata (optional) The POST data to send if the method to be used is POST. This data is in dictionary form.
quality A textual description of the video quality (this will typically be along the lines of `360p`, `720p`, `1080p`, `low`, `medium`, `high`, etc, but any value is possible). If the quality is not specified, this will be set to `unknown`. Don't parse this programmatically - use the `priority` field instead.
format The name of the file format for this video, along the lines of `webm`, `mp4`, `3gp`, `flv`, `wmv`, etc. While this value should typically be pretty consistent, different abbreviations may be used for different resolvers. It's probably not a good idea to automatically parse these unless you know the exact values a resolver will return. This may be set to `unknown`.
priority The priority for this video file. Higher quality video has a lower 'priority'. To always get the highest quality video, go for the URL with the lowest priority (this may not always be 1).
extra This is a dictionary that may contain any custom data provided by the specific resolver that is used. Refer to the resolver-specific documentation for this.

Audio

Key Description
title Title of the audio file.
audiofiles A list of all available audio files.

The list of audio files can contain multiple dictionaries, each of which has the following fields:

Key Description
url URL of the audio file.
method The method to be used for retrieving this URL (either GET or POST).
postdata (optional) The POST data to send if the method to be used is POST. This data is in dictionary form.
quality A textual description of the audio quality (this will typically be along the lines of `low`, `medium`, `high`, `lossless`, etc, but any value is possible). If the quality is not specified, this will be set to `unknown`. Don't parse this programmatically - use the `priority` field instead.
format The name of the file format for this audio file, along the lines of `mp3`, `flac`, `midi`, `ogg`, etc. While this value should typically be pretty consistent, different abbreviations may be used for different resolvers. It's probably not a good idea to automatically parse these unless you know the exact values a resolver will return. This may be set to `unknown`.
priority The priority for this audio file. Higher quality audio has a lower 'priority'. To always get the highest quality audio file, go for the URL with the lowest priority (this may not always be 1).
extra This is a dictionary that may contain any custom data provided by the specific resolver that is used. Refer to the resolver-specific documentation for this.

Images

Key Description
title Title of the image.
images A list of all available image files.

The list of images can contain multiple dictionaries, each of which has the following fields:

Key Description
url URL of the image.
method The method to be used for retrieving this URL (either GET or POST).
postdata (optional) The POST data to send if the method to be used is POST. This data is in dictionary form.
quality A textual description of the image quality (this will typically be along the lines of `low`, `medium`, `high`, `lossless`, etc, but any value is possible). If the quality is not specified, this will be set to `unknown`. Don't parse this programmatically - use the `priority` field instead.
format The name of the file format for this image, along the lines of `jpg`, `png`, `psd`, `svg`, etc. While this value should typically be pretty consistent, different abbreviations may be used for different resolvers. It's probably not a good idea to automatically parse these unless you know the exact values a resolver will return. This may be set to `unknown`.
priority The priority for this image. Higher quality images have a lower 'priority'. To always get the highest quality image, go for the URL with the lowest priority (this may not always be 1).
extra This is a dictionary that may contain any custom data provided by the specific resolver that is used. Refer to the resolver-specific documentation for this.

Files

Key Description
title Title of the file.
files A list of all available URLs for this file.

The list of files can contain multiple dictionaries, each of which has the following fields:

Key Description
url URL of the file.
method The method to be used for retrieving this URL (either GET or POST).
postdata (optional) The POST data to send if the method to be used is POST. This data is in dictionary form.
format The name of the file format, along the lines of `zip`, `mp3`, `pdf`, `doc`, etc. While this value should typically be pretty consistent, different abbreviations may be used for different resolvers. It's probably not a good idea to automatically parse these unless you know the exact values a resolver will return. This may be set to `unknown`.
priority The priority for this URL. More important or faster URLs have a lower 'priority'. To always get the best result, go for the URL with the lowest priority (this may not always be 1).
extra This is a dictionary that may contain any custom data provided by the specific resolver that is used. Refer to the resolver-specific documentation for this.

Text

Key Description
title Title of the text file.
files A list of all available URLs for this file.

The list of text files can contain multiple dictionaries, each of which has the following fields:

Key Description
url URL of the file.
method The method to be used for retrieving this URL (either GET or POST).
postdata (optional) The POST data to send if the method to be used is POST. This data is in dictionary form.
format The name of the file format, along the lines of `zip`, `mp3`, `pdf`, `doc`, etc. While this value should typically be pretty consistent, different abbreviations may be used for different resolvers. It's probably not a good idea to automatically parse these unless you know the exact values a resolver will return. This may be set to `unknown`.
priority The priority for this URL. More important or faster URLs have a lower 'priority'. To always get the best result, go for the URL with the lowest priority (this may not always be 1).
extra This is a dictionary that may contain any custom data provided by the specific resolver that is used. Refer to the resolver-specific documentation for this.