getTorrents

Search for torrents

Request

A JSON-RPC call is a POST of a single envelope object. There is no jsonrpc field, and id must be present and non-empty — an empty or absent id is treated as a notification and the server returns no body at all.

curl -sS -X POST https://api.broadcasthe.net/ \
  -H 'Content-Type: application/json' \
  -d '{"id":1,"method":"getTorrents","params":{"key":"YOUR_API_KEY","search":"<search>"}}'

<?php

$body = json_encode([
    'id' => 1,
    'method' => 'getTorrents',
    'params' => [
        'key' => 'YOUR_API_KEY',
        'search' => '<search>',
    ],
]);

$ch = curl_init("https://api.broadcasthe.net/");
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => $body,
    CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
    CURLOPT_RETURNTRANSFER => true,
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);

// Errors arrive as {"id":…, "result":null, "error":{…}} - result is present and null
// alongside error, so check for the error key rather than a falsy result.
if (isset($response['error'])) {
    throw new RuntimeException($response['error']['message'], $response['error']['code']);
}

var_dump($response['result']);

import requests

response = requests.post(
    "https://api.broadcasthe.net/",
    json={
        "id": 1,
        "method": "getTorrents",
        "params": {
            "key": "YOUR_API_KEY",
            "search": "<search>",
        },
    },
    timeout=30,
)
response.raise_for_status()
payload = response.json()

# result is present and null alongside error, so test for "error" itself.
if "error" in payload:
    raise RuntimeError(f'{payload["error"]["code"]}: {payload["error"]["message"]}')

print(payload["result"])

const response = await fetch("https://api.broadcasthe.net/", {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "id": 1,
    "method": "getTorrents",
    "params": {
      "key": "YOUR_API_KEY",
      "search": "<search>"
    }
  }),
})

const payload = await response.json()

// result is present and null alongside error, so test for the error key itself.
if (payload.error) {
  throw new Error(`${payload.error.code}: ${payload.error.message}`)
}

console.log(payload.result)

Try it

{
  "id": 1,
  "method": "getTorrents",
  "params": {}
}

Parameters

• keystringrequired

  API key

• searchTorrentSearchOptions | [] | [TorrentSearchOptions] | stringrequired
  TorrentSearchOptions | [] | [TorrentSearchOptions] | string

  • eitherTorrentSearchOptions
    • idNumericCriterion (single or array)optional

      A criterion on a numeric field. Send a bare integer for an exact match, or a string, which may carry a >, >=, < or <= prefix to make the match a comparison rather than an equality, e.g. ">=3600".

    • group_idNumericCriterion (single or array)optional
    • tvdbNumericCriterion (single or array)optional
    • tvrageNumericCriterion (single or array)optional
    • imdbNumericCriterion (single or array)optional
    • timeNumericCriterion (single or array)optional
    • sizeNumericCriterion (single or array)optional
    • ageNumericCriterion (single or array)optional
    • hashstring (single or array)optional
    • seriesstringoptional
    • namestringoptional
    • releasestringoptional
    • searchstringoptional
    • tagsstringoptional
    • require_all_tagsbooleanoptional
    • category"Season" | "Episode" (single or array)optional
    • codec12 values (single or array)optional
      12 values

      • "XViD"
      • "x264"
      • "MPEG2"
      • "DiVX"
      • "DVDR"
      • "VC-1"
      • "H.264"
      • "WMV"
      • "BD"
      • "x264-Hi10P"
      • "H.265"
      • "VP9"
    • container10 values (single or array)optional
      10 values

      • "AVI"
      • "MKV"
      • "VOB"
      • "MPEG"
      • "MP4"
      • "ISO"
      • "WMV"
      • "TS"
      • "M4V"
      • "M2TS"
    • source21 values (single or array)optional
      21 values

      • "HDTV"
      • "PDTV"
      • "DSR"
      • "DVDRip"
      • "TVRip"
      • "VHSRip"
      • "Bluray"
      • "BDRip"
      • "BRRip"
      • "DVD5"
      • "DVD9"
      • "HDDVD"
      • "WEB"
      • "BD5"
      • "BD9"
      • "BD25"
      • "BD50"
      • "Mixed"
      • "WEBRip"
      • "WEB-DL"
      • "Unknown"
    • resolution7 values (single or array)optional
      7 values

      • "Portable Device"
      • "SD"
      • "720p"
      • "1080i"
      • "1080p"
      • "576p"
      • "2160p"
    • origin"None" | "Scene" | "P2P" | "User" | "Mixed" | "Internal" (single or array)optional
  • or[]
  • or[TorrentSearchOptions]
  • orstring
• resultsNumericInputoptional

  A whole number, sent either as a JSON number or as a string containing one. 5 and "5" are equivalent, and both are accepted wherever this type appears.

• offsetNumericInputoptional

Result

On success the response is {"id": …, "result": …}. The shape of result is:

• resultsstring (numeric)required
• torrentsmap<string, Torrent>optional
  map<string, Torrent>

  An object keyed by ID — every value has the shape below.

  • GroupNamestringrequired
  • GroupIDstring (numeric)required
  • TorrentIDstring (numeric)required
  • SeriesIDstring (numeric)required
  • Seriesstringrequired
  • SeriesBannerstring | nullrequired
  • SeriesPosterstring | nullrequired
  • YoutubeTrailerstring | nullrequired
  • Category"Episode" | "Season"required
  • Snatchedstring (numeric)required
  • Seedersstring (numeric)required
  • Leechersstring (numeric)required
  • Sourcestringrequired
  • Containerstringrequired
  • Codecstringrequired
  • Resolutionstringrequired
  • Originstringrequired
  • ReleaseNamestringrequired
  • Sizestring (numeric)required
  • Timestring (numeric)required
  • TvdbIDstring | nullrequired
  • TvrageIDstring | nullrequired
  • ImdbIDstring | nullrequired
  • InfoHashstringrequired
  • Tagsstring[]required
  • Genresstring[]required
  • DownloadURLstringrequired

Errors

On failure the response is {"id": …, "result": null, "error": {"code": …, "message": …}}. Note that result is present and null alongsideerror, so test for the error key rather than for a falsy result.

-32004 is the most likely failure on a first call: the API allowlists source IPs, and an unrecognised one is recorded for approval rather than accepted. See authorisation.