This WebUI API documentation applies to qBittorrent v4.1-v4.6.x. For other WebUI API versions, visit WebUI API.

1. Changes
   1. API v2.0
   2. API v2.0.1
   3. API v2.0.2
   4. API v2.1.0
   5. API v2.1.1
   6. API v2.2.0
   7. API v2.2.1
   8. API v2.3.0
   9. API v2.4.0
   10. API v2.4.1
   11. API v2.5.0
   12. API v2.5.1
   13. API v2.6.0
   14. API v2.6.1
   15. API v2.6.2
   16. API v2.7.0
   17. API v2.8.0
   18. API v2.8.1
   19. API v2.8.2
   20. API v2.8.3
2. General information
3. Authentication
   1. Login
   2. Logout
4. Application
   1. Get application version
   2. Get API version
   3. Get build info
   4. Shutdown application
   5. Get application preferences
   6. Set application preferences
   7. Get default save path
5. Log
   1. Get log
   2. Get peer log
6. Sync
   1. Get main data
   2. Get torrent peers data
7. Transfer info
   1. Get global transfer info
   2. Get alternative speed limits state
   3. Toggle alternative speed limits
   4. Get global download limit
   5. Set global download limit
   6. Get global upload limit
   7. Set global upload limit
   8. Ban peers
8. Torrent management
   1. Get torrent list
   2. Get torrent generic properties
   3. Get torrent trackers
   4. Get torrent web seeds
   5. Get torrent contents
   6. Get torrent pieces' states
   7. Get torrent pieces' hashes
   8. Pause torrents
   9. Resume torrents
   10. Delete torrents
   11. Recheck torrents
   12. Reannounce torrents
   13. Edit trackers
   14. Remove trackers
   15. Add peers
   16. Add new torrent
   17. Add trackers to torrent
   18. Increase torrent priority
   19. Decrease torrent priority
   20. Maximal torrent priority
   21. Minimal torrent priority
   22. Set file priority
   23. Get torrent download limit
   24. Set torrent download limit
   25. Set torrent share limit
   26. Get torrent upload limit
   27. Set torrent upload limit
   28. Set torrent location
   29. Set torrent name
   30. Set torrent category
   31. Get all categories
   32. Add new category
   33. Edit category
   34. Remove categories
   35. Add torrent tags
   36. Remove torrent tags
   37. Get all tags
   38. Create tags
   39. Delete tags
   40. Set automatic torrent management
   41. Toggle sequential download
   42. Set first/last piece priority
   43. Set force start
   44. Set super seeding
   45. Rename file
   46. Rename folder
9. RSS (experimental)
   1. Add folder
   2. Add feed
   3. Remove item
   4. Move item
   5. Get all items
   6. Mark as read
   7. Refresh item
   8. Set auto-downloading rule
   9. Rename auto-downloading rule
   10. Remove auto-downloading rule
   11. Get all auto-downloading rules
   12. Get all articles matching a rule
10. Search
    1. Start search
    2. Stop search
    3. Get search status
    4. Get search results
    5. Delete search
    6. Get search plugins
    7. Install search plugin
    8. Uninstall search plugin
    9. Enable search plugin
    10. Update search plugins
11. WebAPI versioning

• New version naming scheme: X.Y.Z (where X - major version, Y - minor version, Z - release version)
• New API paths. All API methods are under api/vX/ (where X is API major version)
• API methods are under new scopes

• Add hashes field to /torrents/info (#8782)
• Add /torrents/setShareLimits/ method (#8598)

• Add /torrents/reannounce method (#9229)

• Change /sync/maindatacategories field from array to object (#9228)
• Add savePath field to /torrents/createCategory (#9228). This method now requires the category to already exist and will not create new categories.
• Add /torrents/editCategory method (#9228)

• Add /torrents/categories method (#9586)
• Add /search/ methods (#8584)
• Add free_space_on_disk field to /sync/maindata (#8217)

• Add /torrents/editTracker and /torrents/removeTracker methods (#9375)
• Add tier, num_seeds, num_leeches, and num_downloaded fields to /torrents/trackers (#9375)
• Change status field from translated string to an integer for /torrents/trackers (#9375)
• Change /torrents/filePrioid field to accept multiple ids (#9541)
• Throw additional errors for failed requests to /torrents/filePrio (#9541)
• Add autoTMM field to /torrents/add (#9752)
• Add various fields to /app/getPreferences and /app/setPreferences (create_subfolder_enabled, start_paused_enabled, auto_delete_mode, preallocate_all, incomplete_files_ext, auto_tmm_enabled, torrent_changed_tmm_enabled, save_path_changed_tmm_enabled, category_changed_tmm_enabled, mail_notification_sender, limit_lan_peers, slow_torrent_dl_rate_threshold, slow_torrent_ul_rate_threshold, slow_torrent_inactive_timer, alternative_webui_enabled, alternative_webui_path) (#9752)

• Add rss/refreshItem (#11067)

• Remove web_ui_password field from /app/preferences, this field is still writable in /app/setPreferences method (#9942)
• Add /app/buildInfo method (#10096)
• Always use / as path separator in /torrents/files response (#10153)
• Add /torrents/addPeers and /transfer/banPeers methods (#10158)
• Add /torrents/addTags, /torrents/removeTags, /torrents/tags, /torrents/createTags, /torrents/deleteTags methods (#10527)

• Add /torrents/renameFile method (#11029)

• Add stalled, stalled_uploading and stalled_downloading as possible values for the filter parameter in /torrents/info (#11825)
• Add various fields to /app/preferences and /app/setPreferences (piece_extent_affinity, web_ui_secure_cookie_enabled, web_ui_max_auth_fail_count, web_ui_ban_duration, stop_tracker_timeout) (#11781, #11726, #12004, #11834)

• Removes enable_super_seeding as fields from /app/preferences and /app/setPreferences (#12423)

• Add web_ui_use_custom_http_headers_enabled, web_ui_custom_http_headers, rss_download_repack_proper_episodes and rss_smart_episode_filters as fields to /app/preferences and /app/setPreferences (#12579, #12549)
• Add /rss/markAsRead and /rss/matchingArticles methods (#12549)

• Removed /search/categories method and modified /search/plugins method's response (#12705)

• Exposed contentPath via the content_path field in the response to /torrents/info (#13625)

• Added tags optional field to /torrents/add (#13882)

• Added /torrents/renameFolder method and modified /torrents/renameFile method's parameters (#13995)

Note that this change was released in qBittorrent v4.3.3, but the WebAPI version was incorrectly set to v2.7.0 (see #14275 for details)

• Added ratioLimit and seedingTimeLimit optional fields to /torrents/add (#14519)
• Added seeding_time field to /torrents/info (#14554)

• Added indexes optional parameter to /torrents/files (#14795)
• Added index field to /torrents/files response (#14795)

• Added tag optional parameter to /torrents/info (#15152)

• All API methods follows the format /api/v2/APIName/methodName, where APIName is a certain subgroup of API methods whose functionality is related.
• All API methods only allows GET or POST methods. Use POST when you are mutating some state (or when your request is too big to fit into GET) and use GET otherwise. Starting with qBittorrent v4.4.4, server will return 405 Method Not Allowed when you used the wrong request method.
• All API methods require authentication (except /api/v2/auth/login, obviously).

All Authentication API methods are under "auth", e.g.: /api/v2/auth/methodName.

qBittorrent uses cookie-based authentication.

Name: login

Parameters:

Returns:

Upon success, the response will contain a cookie with your SID. You must supply the cookie whenever you want to perform an operation that requires authentication.

Example showing how to login and execute a command that requires authentication using curl:

$ curl -i --header 'Referer: http://localhost:8080' --data 'username=admin&password=adminadmin' http://localhost:8080/api/v2/auth/login HTTP/1.1 200 OK Content-Encoding: Content-Length: 3 Content-Type: text/plain; charset=UTF-8 Set-Cookie: SID=hBc7TxF76ERhvIw0jQQ4LZ7Z1jQUV0tQ; path=/ $ curl http://localhost:8080/api/v2/torrents/info --cookie "SID=hBc7TxF76ERhvIw0jQQ4LZ7Z1jQUV0tQ"

Note: Set Referer or Origin header to the exact same domain and port as used in the HTTP query Host header.

Name: logout

Parameters:

None

Returns:

All Application API methods are under "app", e.g.: /api/v2/app/methodName.

Name: version

Parameters:

None

Returns:

The response is a string with the application version, e.g. v4.1.3

Name: webapiVersion

Parameters:

None

Returns:

The response is a string with the WebAPI version, e.g. 2.0

Name: buildInfo

Parameters:

None

Returns:

The response is a JSON object containing the following fields

Name: shutdown

Parameters:

None

Returns:

Name: preferences

Parameters:

None

Returns:

The response is a JSON object with several fields (key-value) pairs representing the application's settings. The contents may vary depending on which settings are present in qBittorrent.ini.

Possible fields:

Possible values of scan_dirs:

Possible values of scheduler_days:

Possible values of encryption:

NB: the first options allows you to use both encrypted and unencrypted connections (this is the default); other options are mutually exclusive: e.g. by forcing encryption on you won't be able to use unencrypted connections and vice versa.

Possible values of proxy_type:

Possible values of dyndns_service:

Possible values of max_ratio_act:

Possible values of bittorrent_protocol:

Possible values of upload_choking_algorithm:

Possible values of upload_slots_behavior:

Possible values of utp_tcp_mixed_mode:

Example:

{ "add_trackers": "", "add_trackers_enabled": false, "alt_dl_limit": 10240, "alt_up_limit": 10240, "alternative_webui_enabled": false, "alternative_webui_path": "/home/user/Documents/qbit-webui", "announce_ip": "", "announce_to_all_tiers": true, "announce_to_all_trackers": false, "anonymous_mode": false, "async_io_threads": 4, "auto_delete_mode": 0, "auto_tmm_enabled": false, "autorun_enabled": false, "autorun_program": "", "banned_IPs": "", "bittorrent_protocol": 0, "bypass_auth_subnet_whitelist": "", "bypass_auth_subnet_whitelist_enabled": false, "bypass_local_auth": false, "category_changed_tmm_enabled": false, "checking_memory_use": 32, "create_subfolder_enabled": true, "current_interface_address": "", "current_network_interface": "", "dht": true, "disk_cache": -1, "disk_cache_ttl": 60, "dl_limit": 0, "dont_count_slow_torrents": false, "dyndns_domain": "changeme.dyndns.org", "dyndns_enabled": false, "dyndns_password": "", "dyndns_service": 0, "dyndns_username": "", "embedded_tracker_port": 9000, "enable_coalesce_read_write": false, "enable_embedded_tracker": false, "enable_multi_connections_from_same_ip": false, "enable_os_cache": true, "enable_piece_extent_affinity": false, "enable_upload_suggestions": false, "encryption": 0, "export_dir": "/home/user/Downloads/all", "export_dir_fin": "/home/user/Downloads/completed", "file_pool_size": 40, "incomplete_files_ext": false, "ip_filter_enabled": false, "ip_filter_path": "", "ip_filter_trackers": false, "limit_lan_peers": true, "limit_tcp_overhead": false, "limit_utp_rate": true, "listen_port": 58925, "locale": "en", "lsd": true, "mail_notification_auth_enabled": false, "mail_notification_email": "", "mail_notification_enabled": false, "mail_notification_password": "", "mail_notification_sender": "qBittorrent_notification@example.com", "mail_notification_smtp": "smtp.changeme.com", "mail_notification_ssl_enabled": false, "mail_notification_username": "", "max_active_downloads": 3, "max_active_torrents": 5, "max_active_uploads": 3, "max_connec": 500, "max_connec_per_torrent": 100, "max_ratio": -1, "max_ratio_act": 0, "max_ratio_enabled": false, "max_seeding_time": -1, "max_seeding_time_enabled": false, "max_uploads": -1, "max_uploads_per_torrent": -1, "outgoing_ports_max": 0, "outgoing_ports_min": 0, "pex": true, "preallocate_all": false, "proxy_auth_enabled": false, "proxy_ip": "0.0.0.0", "proxy_password": "", "proxy_peer_connections": false, "proxy_port": 8080, "proxy_torrents_only": false, "proxy_type": 0, "proxy_username": "", "queueing_enabled": false, "random_port": false, "recheck_completed_torrents": false, "resolve_peer_countries": true, "rss_auto_downloading_enabled":true, "rss_download_repack_proper_episodes":true, "rss_max_articles_per_feed":50, "rss_processing_enabled":true, "rss_refresh_interval":30, "rss_smart_episode_filters":"s(\\d+)e(\\d+)\n(\\d+)x(\\d+)\n(\\d{4}[.\\-]\\d{1,2}[.\\-]\\d{1,2})", "save_path": "/home/user/Downloads/", "save_path_changed_tmm_enabled": false, "save_resume_data_interval": 60, "scan_dirs": { "/home/user/Downloads/incoming/games": 0, "/home/user/Downloads/incoming/movies": 1, }, "schedule_from_hour": 8, "schedule_from_min": 0, "schedule_to_hour": 20, "schedule_to_min": 0, "scheduler_days": 0, "scheduler_enabled": false, "send_buffer_low_watermark": 10, "send_buffer_watermark": 500, "send_buffer_watermark_factor": 50, "slow_torrent_dl_rate_threshold": 2, "slow_torrent_inactive_timer": 60, "slow_torrent_ul_rate_threshold": 2, "socket_backlog_size": 30, "start_paused_enabled": false, "stop_tracker_timeout": 1, "temp_path": "/home/user/Downloads/temp", "temp_path_enabled": false, "torrent_changed_tmm_enabled": true, "up_limit": 0, "upload_choking_algorithm": 1, "upload_slots_behavior": 0, "upnp": true, "use_https": false, "utp_tcp_mixed_mode": 0, "web_ui_address": "*", "web_ui_ban_duration": 3600, "web_ui_clickjacking_protection_enabled": true, "web_ui_csrf_protection_enabled": true, "web_ui_custom_http_headers": "", "web_ui_domain_list": "*", "web_ui_host_header_validation_enabled": true, "web_ui_https_cert_path": "", "web_ui_https_key_path": "", "web_ui_max_auth_fail_count": 5, "web_ui_port": 8080, "web_ui_secure_cookie_enabled": true, "web_ui_session_timeout": 3600, "web_ui_upnp": false, "web_ui_use_custom_http_headers_enabled": false, "web_ui_username": "admin" }

Name: setPreferences

Parameters:

A json object with key-value pairs of the settings you want to change and their new values.

Example:

json={"save_path":"C:/Users/Dayman/Downloads","queueing_enabled":false,"scan_dirs":{"C:/Games": 0,"D:/Downloads": 1}}

Returns:

Notes:

1. There is no need to pass all possible preferences' token:value pairs if you only want to change one option
2. Paths in scan_dirs must exist, otherwise this option will have no effect
3. String values must be quoted; integer and boolean values must never be quoted

For a list of possible preference options see Get application preferences

Name: defaultSavePath

Parameters:

None

Returns:

The response is a string with the default save path, e.g. C:/Users/Dayman/Downloads.

All Log API methods are under "log", e.g.: /api/v2/log/methodName.

Name: main

Parameters:

Example:

/api/v2/log/main?normal=true&info=true&warning=true&critical=true&last_known_id=-1

Returns:

The response is a JSON array in which each element is an entry of the log.

Each element of the array has the following properties:

Example:

[ { "id":0, "message":"qBittorrent v3.4.0 started", "timestamp":1507969127, "type":1 }, { "id":1, "message":"qBittorrent is trying to listen on any interface port: 19036", "timestamp":1507969127, "type":2 }, { "id":2, "message":"Peer ID: -qB3400-", "timestamp":1507969127, "type":1 }, { "id":3, "message":"HTTP User-Agent is 'qBittorrent/3.4.0'", "timestamp":1507969127, "type":1 }, { "id":4, "message":"DHT support [ON]", "timestamp":1507969127, "type":2 }, { "id":5, "message":"Local Peer Discovery support [ON]", "timestamp":1507969127, "type":2 }, { "id":6, "message":"PeX support [ON]", "timestamp":1507969127, "type":2 }, { "id":7, "message":"Anonymous mode [OFF]", "timestamp":1507969127, "type":2 }, { "id":8, "message":"Encryption support [ON]", "timestamp":1507969127, "type":2 }, { "id":9, "message":"Embedded Tracker [OFF]", "timestamp":1507969127, "type":2 }, { "id":10, "message":"UPnP / NAT-PMP support [ON]", "timestamp":1507969127, "type":2 }, { "id":11, "message":"Web UI: Now listening on port 8080", "timestamp":1507969127, "type":1 }, { "id":12, "message":"Options were saved successfully.", "timestamp":1507969128, "type":1 }, { "id":13, "message":"qBittorrent is successfully listening on interface :: port: TCP/19036", "timestamp":1507969128, "type":2 }, { "id":14, "message":"qBittorrent is successfully listening on interface 0.0.0.0 port: TCP/19036", "timestamp":1507969128, "type":2 }, { "id":15, "message":"qBittorrent is successfully listening on interface 0.0.0.0 port: UDP/19036", "timestamp":1507969128, "type":2 } ]

Name: peers

Parameters:

Returns:

The response a JSON array. Each element of the array of objects (each object is the information relative to a peer) containing the following fields

Sync API implements requests for obtaining changes since the last request. All Sync API methods are under "sync", e.g.: /api/v2/sync/methodName.

Name: maindata

Parameters:

Example:

/api/v2/sync/maindata?rid=14

Returns:

The response is a JSON object with the following possible fields

Example:

{ "rid":15, "torrents": { "8c212779b4abde7c6bc608063a0d008b7e40ce32": { "state":"pausedUP" } } }

Name: torrentPeers

Parameters:

Example:

/api/v2/sync/torrentPeers?hash=8c212779b4abde7c6bc608063a0d008b7e40ce32?rid=14

Returns:

The response is TODO

All Transfer info API methods are under "transfer", e.g.: /api/v2/transfer/methodName.

This method returns info you usually see in qBt status bar.

Name: info

Parameters:

None

Returns:

The response is a JSON object with the following fields

In addition to the above in partial data requests (see Get partial data for more info):

Possible values of connection_status:

Example:

{ "connection_status":"connected", "dht_nodes":386, "dl_info_data":681521119, "dl_info_speed":0, "dl_rate_limit":0, "up_info_data":10747904, "up_info_speed":0, "up_rate_limit":1048576 }

Name: speedLimitsMode

Parameters:

None

Returns:

The response is 1 if alternative speed limits are enabled, 0 otherwise.

Name: toggleSpeedLimitsMode

Parameters:

None

Returns:

Name: downloadLimit

Parameters:

None

Returns:

The response is the value of current global download speed limit in bytes/second; this value will be zero if no limit is applied.

Name: setDownloadLimit

Parameters:

Returns:

Name: uploadLimit

Parameters:

None

Returns:

The response is the value of current global upload speed limit in bytes/second; this value will be zero if no limit is applied.

Name: setUploadLimit

Parameters:

Returns:

Name: banPeers

Parameters:

Returns:

All Torrent management API methods are under "torrents", e.g.: /api/v2/torrents/methodName.

Name: info

Parameters:

Example:

/api/v2/torrents/info?filter=downloading&category=sample%20category&sort=ratio

Returns:

The response is a JSON array with the following fields

Possible values of state:

Example:

[ { "dlspeed":9681262, "eta":87, "f_l_piece_prio":false, "force_start":false, "hash":"8c212779b4abde7c6bc608063a0d008b7e40ce32", "category":"", "tags": "", "name":"debian-8.1.0-amd64-CD-1.iso", "num_complete":-1, "num_incomplete":-1, "num_leechs":2, "num_seeds":54, "priority":1, "progress":0.16108787059783936, "ratio":0, "seq_dl":false, "size":657457152, "state":"downloading", "super_seeding":false, "upspeed":0, "isPrivate":true }, { another_torrent_info } ]

Requires knowing the torrent hash. You can get it from torrent list.

Name: properties

Parameters:

Returns:

The response is:

• empty, if the torrent hash is invalid
• otherwise, a JSON object with the following fields

NB: -1 is returned if the type of the property is integer but its value is not known.

Example:

{ "addition_date":1438429165, "comment":"\"Debian CD from cdimage.debian.org\"", "completion_date":1438429234, "created_by":"", "creation_date":1433605214, "dl_limit":-1, "dl_speed":0, "dl_speed_avg":9736015, "eta":8640000, "isPrivate":true, "last_seen":1438430354, "nb_connections":3, "nb_connections_limit":250, "peers":1, "peers_total":89, "piece_size":524288, "pieces_have":1254, "pieces_num":1254, "reannounce":672, "save_path":"/Downloads/debian-8.1.0-amd64-CD-1.iso", "seeding_time":1128, "seeds":1, "seeds_total":254, "share_ratio":0.00072121022562178299, "time_elapsed":1197, "total_downloaded":681521119, "total_downloaded_session":681521119, "total_size":657457152, "total_uploaded":491520, "total_uploaded_session":491520, "total_wasted":23481724, "up_limit":-1, "up_speed":0, "up_speed_avg":410 }

Requires knowing the torrent hash. You can get it from torrent list.

Name: trackers

Parameters:

Returns:

The response is a JSON array, where each element contains info about one tracker, with the following fields

Possible values of status:

Example:

[ { "msg":"", "num_peers":100, "status":2, "url":"http://bttracker.debian.org:6969/announce" }, { another_tracker_info } ]

Requires knowing the torrent hash. You can get it from torrent list.

Name: webseeds

Parameters:

Returns:

The response is a JSON array, where each element is information about one webseed, with the following fields

Example:

[ { "url":"http://some_url/" }, { "url":"http://some_other_url/" } ]

Requires knowing the torrent hash. You can get it from torrent list.

Name: files

Parameters:

Returns:

The response is:

• empty, if the torrent hash is invalid
• otherwise, a JSON array, where each element contains info about one file, with the following fields

Possible values of priority:

Example:

[ { "index":0, "is_seed":false, "name":"debian-8.1.0-amd64-CD-1.iso", "piece_range":[0,1253], "priority":1, "progress":0, "size":657457152, "availability":0.5, } ]

Requires knowing the torrent hash. You can get it from torrent list.

Name: pieceStates

Parameters:

Returns:

The response is:

• empty, if the torrent hash is invalid
• otherwise, an array of states (integers) of all pieces (in order) of a specific torrent.

Value meanings are defined as below:

Example:

[0,0,2,1,0,0,2,1]

Requires knowing the torrent hash. You can get it from torrent list.

Name: pieceHashes

Parameters:

Returns:

The response is:

• empty, if the torrent hash is invalid
• otherwise, an array of hashes (strings) of all pieces (in order) of a specific torrent.

Example:

["54eddd830a5b58480a6143d616a97e3a6c23c439","f8a99d225aa4241db100f88407fc3bdaead583ab","928fb615b9bd4dd8f9e9022552c8f8f37ef76f58"]

Requires knowing the torrent hashes. You can get it from torrent list.

Name: pause

Parameters:

Example:

/api/v2/torrents/pause?hashes=8c212779b4abde7c6bc608063a0d008b7e40ce32|54eddd830a5b58480a6143d616a97e3a6c23c439

Returns:

Requires knowing the torrent hashes. You can get it from torrent list.

Name: resume

Parameters:

Example:

/api/v2/torrents/resume?hashes=8c212779b4abde7c6bc608063a0d008b7e40ce32|54eddd830a5b58480a6143d616a97e3a6c23c439

Returns:

Requires knowing the torrent hashes. You can get it from torrent list.

Name: delete

Parameters:

Example:

/api/v2/torrents/delete?hashes=8c212779b4abde7c6bc608063a0d008b7e40ce32&deleteFiles=false

Returns:

Requires knowing the torrent hashes. You can get it from torrent list.

Name: recheck

Parameters:

Example:

/api/v2/torrents/recheck?hashes=8c212779b4abde7c6bc608063a0d008b7e40ce32|54eddd830a5b58480a6143d616a97e3a6c23c439

Returns:

Requires knowing the torrent hashes. You can get it from torrent list.

Name: reannounce

Parameters:

Example:

/api/v2/torrents/reannounce?hashes=8c212779b4abde7c6bc608063a0d008b7e40ce32|54eddd830a5b58480a6143d616a97e3a6c23c439

Returns:

This method can add torrents from server local file or from URLs. http://, https://, magnet: and bc://bt/ links are supported.

Add torrent from URLs example:

POST /api/v2/torrents/add HTTP/1.1User-Agent: FiddlerHost: 127.0.0.1Cookie: SID=your_sidContent-Type: multipart/form-data; boundary=---------------------------6688794727912Content-Length: length-----------------------------6688794727912Content-Disposition: form-data; name="urls"https://torcache.net/torrent/3B1A1469C180F447B77021074DBBCCAEF62611E7.torrenthttps://torcache.net/torrent/3B1A1469C180F447B77021074DBBCCAEF62611E8.torrent-----------------------------6688794727912Content-Disposition: form-data; name="savepath"C:/Users/qBit/Downloads-----------------------------6688794727912Content-Disposition: form-data; name="cookie"ui=28979218048197-----------------------------6688794727912Content-Disposition: form-data; name="category"movies-----------------------------6688794727912Content-Disposition: form-data; name="skip_checking"true-----------------------------6688794727912Content-Disposition: form-data; name="paused"true-----------------------------6688794727912Content-Disposition: form-data; name="root_folder"true-----------------------------6688794727912--

Add torrents from files example:

POST /api/v2/torrents/add HTTP/1.1Content-Type: multipart/form-data; boundary=-------------------------acebdf13572468User-Agent: FiddlerHost: 127.0.0.1Cookie: SID=your_sidContent-Length: length---------------------------acebdf13572468Content-Disposition: form-data; name="torrents"; filename="8f18036b7a205c9347cb84a253975e12f7adddf2.torrent"Content-Type: application/x-bittorrentfile_binary_data_goes_here---------------------------acebdf13572468Content-Disposition: form-data; name="torrents"; filename="UFS.torrent"Content-Type: application/x-bittorrentfile_binary_data_goes_here---------------------------acebdf13572468--

The above example will add two torrent files. file_binary_data_goes_here represents raw data of torrent file (basically a byte array).

Returns:

Requires knowing the torrent hash. You can get it from torrent list.

POST /api/v2/torrents/addTrackers HTTP/1.1User-Agent: FiddlerHost: 127.0.0.1Cookie: SID=your_sidContent-Type: application/x-www-form-urlencodedContent-Length: lengthhash=8c212779b4abde7c6bc608063a0d008b7e40ce32&urls=http://192.168.0.1/announce%0Audp://192.168.0.1:3333/dummyAnnounce

This adds two trackers to torrent with hash 8c212779b4abde7c6bc608063a0d008b7e40ce32. Note %0A (aka LF newline) between trackers. Ampersand in tracker urls MUST be escaped.

Returns:

Name: editTracker

Parameters:

Returns:

Name: removeTrackers

Parameters:

Returns:

Name: addPeers

Parameters:

Returns:

Requires knowing the torrent hash. You can get it from torrent list.

Name: increasePrio

Parameters:

Example:

/api/v2/torrents/increasePrio?hashes=8c212779b4abde7c6bc608063a0d008b7e40ce32|54eddd830a5b58480a6143d616a97e3a6c23c439

Returns:

Requires knowing the torrent hash. You can get it from torrent list.

Name: decreasePrio

Parameters:

Example:

/api/v2/torrents/decreasePrio?hashes=8c212779b4abde7c6bc608063a0d008b7e40ce32|54eddd830a5b58480a6143d616a97e3a6c23c439

Returns:

Requires knowing the torrent hash. You can get it from torrent list.

Name: topPrio

Parameters:

Example:

/api/v2/torrents/topPrio?hashes=8c212779b4abde7c6bc608063a0d008b7e40ce32|54eddd830a5b58480a6143d616a97e3a6c23c439

Returns:

Requires knowing the torrent hash. You can get it from torrent list.

Name: bottomPrio

Parameters:

Example:

/api/v2/torrents/bottomPrio?hashes=8c212779b4abde7c6bc608063a0d008b7e40ce32|54eddd830a5b58480a6143d616a97e3a6c23c439

Returns:

Name: filePrio

Parameters:

id values correspond to file position inside the array returned by torrent contents API, e.g. id=0 for first file, id=1 for second file, etc.

Since 2.8.2 it is recommended to use index field returned by torrent contents API (since the files can be filtered and the index value may differ from the position inside the response array).

Returns:

Requires knowing the torrent hash. You can get it from torrent list.

POST /api/v2/torrents/downloadLimit HTTP/1.1User-Agent: FiddlerHost: 127.0.0.1Cookie: SID=your_sidContent-Type: application/x-www-form-urlencodedContent-Length: lengthhashes=8c212779b4abde7c6bc608063a0d008b7e40ce32|284b83c9c7935002391129fd97f43db5d7cc2ba0

hashes can contain multiple hashes separated by | or set to all

Server reply (example):

HTTP/1.1 200 OKcontent-type: application/jsoncontent-length: length {"8c212779b4abde7c6bc608063a0d008b7e40ce32":338944,"284b83c9c7935002391129fd97f43db5d7cc2ba0":123}

8c212779b4abde7c6bc608063a0d008b7e40ce32 is the hash of the torrent and 338944 its download speed limit in bytes per second; this value will be zero if no limit is applied.

Requires knowing the torrent hash. You can get it from torrent list.

POST /api/v2/torrents/setDownloadLimit HTTP/1.1User-Agent: FiddlerHost: 127.0.0.1Cookie: SID=your_sidContent-Type: application/x-www-form-urlencodedContent-Length: lengthhashes=8c212779b4abde7c6bc608063a0d008b7e40ce32|284b83c9c7935002391129fd97f43db5d7cc2ba0&limit=131072

hashes can contain multiple hashes separated by | or set to alllimit is the download speed limit in bytes per second you want to set.

Returns:

Requires knowing the torrent hash. You can get it from torrent list.

POST /api/v2/torrents/setShareLimits HTTP/1.1User-Agent: FiddlerHost: 127.0.0.1Cookie: SID=your_sidContent-Type: application/x-www-form-urlencodedContent-Length: lengthhashes=8c212779b4abde7c6bc608063a0d008b7e40ce32|284b83c9c7935002391129fd97f43db5d7cc2ba0&ratioLimit=1.0&seedingTimeLimit=60&inactiveSeedingTimeLimit=-2

Parameters:

Returns:

Requires knowing the torrent hash. You can get it from torrent list.

POST /api/v2/torrents/uploadLimit HTTP/1.1User-Agent: FiddlerHost: 127.0.0.1Cookie: SID=your_sidContent-Type: application/x-www-form-urlencodedContent-Length: lengthhashes=8c212779b4abde7c6bc608063a0d008b7e40ce32|284b83c9c7935002391129fd97f43db5d7cc2ba0

hashes can contain multiple hashes separated by | or set to all

Server reply (example):

HTTP/1.1 200 OKcontent-type: application/jsoncontent-length: length {"8c212779b4abde7c6bc608063a0d008b7e40ce32":338944,"284b83c9c7935002391129fd97f43db5d7cc2ba0":123}

8c212779b4abde7c6bc608063a0d008b7e40ce32 is the hash of the torrent in the request and 338944 its upload speed limit in bytes per second; this value will be zero if no limit is applied.

Requires knowing the torrent hash. You can get it from torrent list.

POST /api/v2/torrents/setUploadLimit HTTP/1.1User-Agent: FiddlerHost: 127.0.0.1Cookie: SID=your_sidContent-Type: application/x-www-form-urlencodedContent-Length: lengthhashes=8c212779b4abde7c6bc608063a0d008b7e40ce32|284b83c9c7935002391129fd97f43db5d7cc2ba0&limit=131072

hashes can contain multiple hashes separated by | or set to alllimit is the upload speed limit in bytes per second you want to set.

Returns:

Requires knowing the torrent hash. You can get it from torrent list.

POST /api/v2/torrents/setLocation HTTP/1.1User-Agent: FiddlerHost: 127.0.0.1Cookie: SID=your_sidContent-Type: application/x-www-form-urlencodedContent-Length: lengthhashes=8c212779b4abde7c6bc608063a0d008b7e40ce32|284b83c9c7935002391129fd97f43db5d7cc2ba0&location=/mnt/nfs/media

hashes can contain multiple hashes separated by | or set to alllocation is the location to download the torrent to. If the location doesn't exist, the torrent's location is unchanged.

Returns:

Requires knowing the torrent hash. You can get it from torrent list.

POST /api/v2/torrents/rename HTTP/1.1User-Agent: FiddlerHost: 127.0.0.1Cookie: SID=your_sidContent-Type: application/x-www-form-urlencodedContent-Length: lengthhash=8c212779b4abde7c6bc608063a0d008b7e40ce32&name=This%20is%20a%20test

Returns:

Requires knowing the torrent hash. You can get it from torrent list.

POST /api/v2/torrents/setCategory HTTP/1.1User-Agent: FiddlerHost: 127.0.0.1Cookie: SID=your_sidContent-Type: application/x-www-form-urlencodedContent-Length: lengthhashes=8c212779b4abde7c6bc608063a0d008b7e40ce32|284b83c9c7935002391129fd97f43db5d7cc2ba0&category=CategoryName

hashes can contain multiple hashes separated by | or set to all

category is the torrent category you want to set.

Returns:

Name: categories

Parameters:

None

Returns all categories in JSON format, e.g.:

{ "Video": { "name": "Video", "savePath": "/home/user/torrents/video/" }, "eBooks": { "name": "eBooks", "savePath": "/home/user/torrents/eBooks/" } }

Returns:

POST /api/v2/torrents/createCategory HTTP/1.1User-Agent: FiddlerHost: 127.0.0.1Cookie: SID=your_sidContent-Type: application/x-www-form-urlencodedContent-Length: lengthcategory=CategoryName&savePath=/path/to/dir

category is the category you want to create.

Returns:

POST /api/v2/torrents/editCategory HTTP/1.1User-Agent: FiddlerHost: 127.0.0.1Cookie: SID=your_sidContent-Type: application/x-www-form-urlencodedContent-Length: lengthcategory=CategoryName&savePath=/path/to/save/torrents/to

Returns:

POST /api/v2/torrents/removeCategories HTTP/1.1User-Agent: FiddlerHost: 127.0.0.1Cookie: SID=your_sidContent-Type: application/x-www-form-urlencodedContent-Length: lengthcategories=Category1%0ACategory2

categories can contain multiple cateogies separated by \n (%0A urlencoded)

Returns:

Requires knowing the torrent hash. You can get it from torrent list.

POST /api/v2/torrents/addTags HTTP/1.1User-Agent: FiddlerHost: 127.0.0.1Cookie: SID=your_sidContent-Type: application/x-www-form-urlencodedContent-Length: lengthhashes=8c212779b4abde7c6bc608063a0d008b7e40ce32|284b83c9c7935002391129fd97f43db5d7cc2ba0&tags=TagName1,TagName2

hashes can contain multiple hashes separated by | or set to all

tags is the list of tags you want to add to passed torrents.

Returns:

Requires knowing the torrent hash. You can get it from torrent list.

POST /api/v2/torrents/removeTags HTTP/1.1User-Agent: FiddlerHost: 127.0.0.1Cookie: SID=your_sidContent-Type: application/x-www-form-urlencodedContent-Length: lengthhashes=8c212779b4abde7c6bc608063a0d008b7e40ce32|284b83c9c7935002391129fd97f43db5d7cc2ba0&tags=TagName1,TagName2

hashes can contain multiple hashes separated by | or set to all

tags is the list of tags you want to remove from passed torrents. Empty list removes all tags from relevant torrents.

Returns:

Name: tags

Parameters:

None

Returns all tags in JSON format, e.g.:

[ "Tag 1", "Tag 2" ]

Returns:

POST /api/v2/torrents/createTags HTTP/1.1User-Agent: FiddlerHost: 127.0.0.1Cookie: SID=your_sidContent-Type: application/x-www-form-urlencodedContent-Length: lengthtags=TagName1,TagName2

tags is a list of tags you want to create. Can contain multiple tags separated by ,.

Returns:

POST /api/v2/torrents/deleteTags HTTP/1.1User-Agent: FiddlerHost: 127.0.0.1Cookie: SID=your_sidContent-Type: application/x-www-form-urlencodedContent-Length: lengthtags=TagName1,TagName2

tags is a list of tags you want to delete. Can contain multiple tags separated by ,.

Returns:

Requires knowing the torrent hash. You can get it from torrent list.

POST /api/v2/torrents/setAutoManagement HTTP/1.1User-Agent: FiddlerHost: 127.0.0.1Cookie: SID=your_sidContent-Type: application/x-www-form-urlencodedContent-Length: lengthhashes=8c212779b4abde7c6bc608063a0d008b7e40ce32|284b83c9c7935002391129fd97f43db5d7cc2ba0&enable=true

hashes can contain multiple hashes separated by | or set to allenable is a boolean, affects the torrents listed in hashes, default is false

Returns:

Requires knowing the torrent hash. You can get it from torrent list.

Name: toggleSequentialDownload

Parameters:

Example:

/api/v2/torrents/toggleSequentialDownload?hashes=8c212779b4abde7c6bc608063a0d008b7e40ce32|54eddd830a5b58480a6143d616a97e3a6c23c439

Returns:

Requires knowing the torrent hash. You can get it from torrent list.

Name: toggleFirstLastPiecePrio

Parameters:

Example:

/api/v2/torrents/toggleFirstLastPiecePrio?hashes=8c212779b4abde7c6bc608063a0d008b7e40ce32|54eddd830a5b58480a6143d616a97e3a6c23c439

Returns:

Requires knowing the torrent hash. You can get it from torrent list.

POST /api/v2/torrents/setForceStart HTTP/1.1User-Agent: FiddlerHost: 127.0.0.1Cookie: SID=your_sidContent-Type: application/x-www-form-urlencodedContent-Length: lengthhashes=8c212779b4abde7c6bc608063a0d008b7e40ce32?value=true

hashes can contain multiple hashes separated by | or set to allvalue is a boolean, affects the torrents listed in hashes, default is false

Returns:

Requires knowing the torrent hash. You can get it from torrent list.

POST /api/v2/torrents/setSuperSeeding HTTP/1.1User-Agent: FiddlerHost: 127.0.0.1Cookie: SID=your_sidContent-Type: application/x-www-form-urlencodedContent-Length: lengthhashes=8c212779b4abde7c6bc608063a0d008b7e40ce32?value=true

hashes can contain multiple hashes separated by | or set to allvalue is a boolean, affects the torrents listed in hashes, default is false

Returns:

Name: renameFile

Parameters:

Returns:

Name: renameFolder

Parameters:

Returns:

All RSS API methods are under "rss", e.g.: /api/v2/rss/methodName.

Name: addFolder

Parameters:

Returns:

Name: addFeed

Parameters:

Returns:

Removes folder or feed.

Name: removeItem

Parameters:

Returns:

Moves/renames folder or feed.

Name: moveItem

Parameters:

Returns:

Name: items

Parameters:

Returns all RSS items in JSON format, e.g.:

{ "HD-Torrents.org": "https://hd-torrents.org/rss.php", "PowerfulJRE": "https://www.youtube.com/feeds/videos.xml?channel_id=UCzQUP1qoWDoEbmsQxvdjxgQ", "The Pirate Bay": { "Audio": "https://thepiratebay.org/rss//top100/100", "Video": "https://thepiratebay.org/rss//top100/200" } }

If articleId is provided only the article is marked as read otherwise the whole feed is going to be marked as read.

Name: markAsRead

Parameters:

Returns:

Refreshes folder or feed.

Name: refreshItem

Parameters:

Returns:

Name: setRule

Parameters:

Rule definition is JSON encoded dictionary with the following fields:

E.g.:

{ "enabled": false, "mustContain": "The *Punisher*", "mustNotContain": "", "useRegex": false, "episodeFilter": "1x01-;", "smartFilter": false, "previouslyMatchedEpisodes": [ ], "affectedFeeds": [ "http://showrss.info/user/134567.rss?magnets=true" ], "ignoreDays": 0, "lastMatch": "20 Nov 2017 09:05:11", "addPaused": true, "assignedCategory": "", "savePath": "C:/Users/JohnDoe/Downloads/Punisher" }

Name: renameRule

Parameters:

Returns:

Name: removeRule

Parameters:

Returns:

Name: rules

Returns all auto-downloading rules in JSON format, e.g.:

{ "The Punisher": { "enabled": false, "mustContain": "The *Punisher*", "mustNotContain": "", "useRegex": false, "episodeFilter": "1x01-;", "smartFilter": false, "previouslyMatchedEpisodes": [ ], "affectedFeeds": [ "http://showrss.info/user/134567.rss?magnets=true" ], "ignoreDays": 0, "lastMatch": "20 Nov 2017 09:05:11", "addPaused": true, "assignedCategory": "", "savePath": "C:/Users/JohnDoe/Downloads/Punisher" } }

Returns:

Name: matchingArticles

Returns all articles that match a rule by feed name in JSON format, e.g.:

{ "DistroWatch":[ "sparkylinux-5.11-i686-minimalgui.iso.torrent", "sparkylinux-5.11-x86_64-minimalgui.iso.torrent", "sparkylinux-5.11-i686-xfce.iso.torrent", "bluestar-linux-5.6.3-2020.04.09-x86_64.iso.torrent", "robolinux64-mate3d-v10.10.iso.torrent", ], "Linuxtracker":[ "[Alpine Linux] alpine-extended-3.11.6", "[Alpine Linux] alpine-standard-3.11.6", "[Linuxfx] linuxfx10-wxs-lts-beta5.iso", "[Linux Lite] linux-lite-5.0-rc1-64bit.iso (MULTI)", "[Scientific Linux] SL-7.8-x86_64-Pack", "[NixOS] nixos-plasma5-20.03.1418.5272327b81e-x86_64-linux.iso" ] }

Returns:

All Search API methods are under "search", e.g.: /api/v2/search/methodName.

Name: start

Parameters:

Returns:

The response is a JSON object with the following fields

Example:

{ "id": 12345 }

Name: stop

Parameters:

Returns:

Name: status

Parameters:

Returns:

The response is a JSON array of objects containing the following fields

Example:

[ { "id": 12345, "status": "Running", "total": 170 } ]

Name: results

Parameters:

Returns:

The response is a JSON object with the following fields

Result object:

Example:

{ "results": [ { "descrLink": "http://www.legittorrents.info/index.php?page=torrent-details&id=8d5f512e1acb687029b8d7cc6c5a84dce51d7a41", "fileName": "Ubuntu-10.04-32bit-NeTV.ova", "fileSize": -1, "fileUrl": "http://www.legittorrents.info/download.php?id=8d5f512e1acb687029b8d7cc6c5a84dce51d7a41&f=Ubuntu-10.04-32bit-NeTV.ova.torrent", "nbLeechers": 1, "nbSeeders": 0, "siteUrl": "http://www.legittorrents.info" }, { "descrLink": "http://www.legittorrents.info/index.php?page=torrent-details&id=d5179f53e105dc2c2401bcfaa0c2c4936a6aa475", "fileName": "mangOH-Legato-17_06-Ubuntu-16_04.ova", "fileSize": -1, "fileUrl": "http://www.legittorrents.info/download.php?id=d5179f53e105dc2c2401bcfaa0c2c4936a6aa475&f=mangOH-Legato-17_06-Ubuntu-16_04.ova.torrent", "nbLeechers": 0, "nbSeeders": 59, "siteUrl": "http://www.legittorrents.info" } ], "status": "Running", "total": 2 }

Name: delete

Parameters:

Returns:

Name: plugins

Parameters:

None

Returns:

The response is a JSON array of objects containing the following fields

[ { "enabled": true, "fullName": "Legit Torrents", "name": "legittorrents", "supportedCategories": [{ "id": "all", "name": "All categories" }, { "id": "anime", "name": "Anime" }, { "id": "books", "name": "Books" }, { "id": "games", "name": "Games" }, { "id": "movies", "name": "Movies" }, { "id": "music", "name": "Music" }, { "id": "tv", "name": "TV shows" }], "url": "http://www.legittorrents.info", "version": "2.3" } ]

Name: installPlugin

Parameters:

Returns:

Name: uninstallPlugin

Parameters:

Returns:

Name: enablePlugin

Parameters:

Returns:

Name: updatePlugins

Parameters:

None

Returns:

WebAPI uses the following versioning: 1.2.3:

1. Main version. Should be changed only on some global changes (e.g. total redesign/relayout)
2. Changed on incompatible API changes (i.e. if it breaks outdated clients). E.g. if you change/remove something
3. Changed on compatible API changes (i.e. if it doesn't break outdated clients). E.g. if you add something new outdated clients still can access old subset of API.