PreDB.net API

https://predb.net/api-documentation
Admin
PreDB.net API provides access to a pre & nfo database containing release information from scenes...
Tokens:7,552
Snippets:27
Trust Score:7
Update:9 months ago
Show doc for...
Tokens:
Raw
### Search Releases by Release Name

Source: https://predb.net/api-documentation/index

This endpoint allows you to search for a specific release by its name. It returns a list of matching releases, if any.

```APIDOC
## GET /?release={release_name}

### Description
Searches for releases matching the provided release name.

### Method
GET

### Endpoint
`/?release={release_name}`

### Query Parameters
- **release** (string) - Required - The name of the release to search for.

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the request ('success' or 'error').
- **message** (string) - Contains any error message if the status is 'error'.
- **results** (integer) - The number of releases found.
- **data** (array) - An array of release objects, each containing:
    - **id** (integer) - Unique identifier for the release.
    - **pretime** (integer) - Timestamp of when the release was preed.
    - **release** (string) - The name of the release.
    - **section** (string) - The section the release belongs to (e.g., 'GAMES').
    - **files** (integer) - The number of files in the release.
    - **size** (integer) - The size of the release in KB.
    - **status** (integer) - Status of the release (e.g., 0 for not nuked, 1 for nuked).
    - **reason** (string) - Reason for the status, if applicable.
    - **group** (string) - The group that released this release.
    - **genre** (string) - The genre of the release.
    - **url** (string) - A relative URL to the release details.
    - **nfo** (string) - A URL to the NFO file.
    - **nfo_image** (string) - A URL to the NFO image.
- **time** (string) - The time taken to process the request.

#### Response Example
```json
{
	"status": "success",
	"message": "",
	"results": 1,
	"data": [
		{
			"id": 8595904,
			"pretime": 1634804390,
			"release": "Toy.Soldiers.HD-DOGE",
			"section": "GAMES",
			"files": 87,
			"size": 4124,
			"status": 1,
			"reason": "bad.crack_game.crashes.when.selecting.private.match.in.the.online.menu_get.PLAZA.proper",
			"group": "DOGE",
			"genre": "",
			"url": "/rls/Toy.Soldiers.HD-DOGE",
			"nfo": "https://api.predb.net/nfo/Toy.Soldiers.HD-DOGE.nfo",
			"nfo_image": "https://api.predb.net/nfoimg/Toy.Soldiers.HD-DOGE.png"
		}
	],
	"time": "0.0022s"
}
```
```

--------------------------------

### Specific Release Search (type=pre)

Source: https://predb.net/api-documentation/index

Retrieves information for a specific release using its exact name.

```APIDOC
## GET /api/search?type=pre

### Description
Searches for an exact release by its name.

### Method
GET

### Endpoint
https://api.predb.net/

### Parameters
#### Query Parameters
- **type** (string) - Required - Must be set to `pre`.
- **release** (string) - Required - The exact name of the release to search for.
- **group** (string) - Optional - Filter by group name. Supports multiple values (comma-separated) and exclusions (prefixed with '-').
- **section** (string) - Optional - Filter by section name. Supports multiple values (comma-separated) and exclusions (prefixed with '-').
- **genre** (string) - Optional - Filter by genre. Supports multiple values (comma-separated) and exclusions (prefixed with '-').
- **tag** (string) - Optional - Filter by tags (e.g., PROPER, 2160p). Supports multiple values (comma-separated) and exclusions (prefixed with '-'). Special tag: 'foreign' (in-/excludes non-English releases).
- **status** (string) - Optional - Filter by release status (nuked, unnuked). Supports multiple values (comma-separated) and exclusions (prefixed with '-').
- **order_by** (string) - Optional - Field to order results by. Possible values: pretime, release. Default: pretime.
- **sort** (string) - Optional - Sort order. Possible values: ASC, DESC. Default: DESC.
- **limit** (int) - Optional - Number of results per page. Max value: 100. Default: 20.
- **page** (int) - Optional - Page offset. Max value: 1000. Default: 1.

### Request Example
```json
{
  "request": "GET /?type=pre&release=Example.Release.Name.1080p.BluRay.x264-GROUP"
}
```

### Response
#### Success Response (200)
- **results** (array) - Array of release objects (similar to the general search endpoint).

#### Response Example
```json
{
  "results": [
    {
      "pre": "abc123def456",
      "name": "Example.Release.Name.1080p.BluRay.x264-GROUP",
      "group": "GROUP",
      "size": 1073741824,
      "added": 1678886400
    }
  ]
}
```
```

--------------------------------

### General Search Endpoint

Source: https://predb.net/api-documentation/index

This endpoint allows for general keyword searches within release names. It supports various parameters for filtering and sorting results.

```APIDOC
## GET /api/search

### Description
Performs a simple keyword search for releases. The search starts at the beginning of a release name.

### Method
GET

### Endpoint
https://api.predb.net/

### Parameters
#### Query Parameters
- **q** (string) - Optional - Keywords to search for in the release name.
- **group** (string) - Optional - Filter by group name. Supports multiple values (comma-separated) and exclusions (prefixed with '-').
- **section** (string) - Optional - Filter by section name. Supports multiple values (comma-separated) and exclusions (prefixed with '-').
- **genre** (string) - Optional - Filter by genre. Supports multiple values (comma-separated) and exclusions (prefixed with '-').
- **tag** (string) - Optional - Filter by tags (e.g., PROPER, 2160p). Supports multiple values (comma-separated) and exclusions (prefixed with '-'). Special tag: 'foreign' (in-/excludes non-English releases).
- **status** (string) - Optional - Filter by release status (nuked, unnuked). Supports multiple values (comma-separated) and exclusions (prefixed with '-').
- **order_by** (string) - Optional - Field to order results by. Possible values: pretime, release. Default: pretime.
- **sort** (string) - Optional - Sort order. Possible values: ASC, DESC. Default: DESC.
- **limit** (int) - Optional - Number of results per page. Max value: 100. Default: 20.
- **page** (int) - Optional - Page offset. Max value: 1000. Default: 1.

### Request Example
```json
{
  "request": "GET /?q=some_keyword&group=CODEX,CORE&tag=-foreign&limit=50"
}
```

### Response
#### Success Response (200)
- **results** (array) - Array of release objects.
  - **pre** (string) - The pre identifier for the release.
  - **name** (string) - The full name of the release.
  - **group** (string) - The group that released it.
  - **size** (integer) - The size of the release in bytes.
  - **added** (integer) - Timestamp when the release was added.

#### Response Example
```json
{
  "results": [
    {
      "pre": "abc123def456",
      "name": "Example.Release.Name.1080p.BluRay.x264-GROUP",
      "group": "GROUP",
      "size": 1073741824,
      "added": 1678886400
    }
  ]
}
```
```

--------------------------------

### Search Releases by Group

Source: https://predb.net/api-documentation/index

This endpoint allows you to search for releases made by a specific group, with pagination support.

```APIDOC
## GET /?group={group_name}&page={page_number}

### Description
Retrieves a paginated list of releases made by a specific group.

### Method
GET

### Endpoint
`/?group={group_name}&page={page_number}`

### Query Parameters
- **group** (string) - Required - The name of the group to search releases for.
- **page** (integer) - Optional - The page number for pagination. Defaults to 1 if not provided.

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the request ('success' or 'error').
- **message** (string) - Contains any error message if the status is 'error'.
- **data** (array) - An array of release objects, each containing:
    - **id** (integer) - Unique identifier for the release.
    - **pretime** (integer) - Timestamp of when the release was preed.
    - **release** (string) - The name of the release.
    - **section** (string) - The section the release belongs to (e.g., 'GAMES').
    - **files** (integer) - The number of files in the release.
    - **size** (integer) - The size of the release in KB.
    - **status** (integer) - Status of the release (e.g., 0 for not nuked, 1 for nuked).
    - **reason** (string) - Reason for the status, if applicable.
    - **group** (string) - The group that released this release.
    - **genre** (string) - The genre of the release.
    - **url** (string) - A relative URL to the release details.
- **page** (integer) - The current page number.
- **results** (integer) - The number of releases per page.
- **time** (string) - The time taken to process the request.

#### Response Example
```json
{
	"status": "success",
	"message": "",
	"data": [
		{
			"id": 8580982,
			"pretime": 1633928324,
			"release": "Warhammer.Age.of.Sigmar.Storm.Ground.Update.v1.3-CODEX",
			"section": "GAMES",
			"files": 31,
			"size": 1449,
			"status": 0,
			"reason": "",
			"group": "CODEX",
			"genre": "",
			"url": "/rls/Warhammer.Age.of.Sigmar.Storm.Ground.Update.v1.3-CODEX"
		},
		{
			"id": 8580981,
			"pretime": 1633928300,
			"release": "Warhammer.40000.Dakka.Squadron.Flyboyz.Edition.Update.v154277-CODEX",
			"section": "GAMES",
			"files": 12,
			"size": 171,
			"status": 0,
			"reason": "",
			"group": "CODEX",
			"genre": "",
			"url": "/rls/Warhammer.40000.Dakka.Squadron.Flyboyz.Edition.Update.v154277-CODEX"
		}
	],
	"page": 2,
	"results": 20,
	"time": 0.1071
}
```
```

--------------------------------

### Database Statistics (type=stats)

Source: https://predb.net/api-documentation/index

Retrieves general statistics about the database.

```APIDOC
## GET /api/search?type=stats

### Description
Retrieves general statistics about the PreDB.net database.

### Method
GET

### Endpoint
https://api.predb.net/

### Parameters
#### Query Parameters
- **type** (string) - Required - Must be set to `stats`.

### Request Example
```json
{
  "request": "GET /?type=stats"
}
```

### Response
#### Success Response (200)
- **total_releases** (integer) - Total number of releases in the database.
- **total_groups** (integer) - Total number of unique groups.
- **total_size** (integer) - Total size of all releases in bytes.
- **last_update** (integer) - Timestamp of the last database update.

#### Response Example
```json
{
  "total_releases": 15000000,
  "total_groups": 50000,
  "total_size": 15000000000000,
  "last_update": 1678886400
}
```
```

--------------------------------

### General Database Statistics

Source: https://predb.net/api-documentation/index

Retrieves overall statistics about the predb.net database.

```APIDOC
## GET /?type=stats

### Description
Fetches general statistics for the entire predb.net database.

### Method
GET

### Endpoint
`/?type=stats`

### Query Parameters
- **type** (string) - Required - Must be set to 'stats'.

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the request ('success' or 'error').
- **message** (string) - Contains any error message if the status is 'error'.
- **results** (integer) - The number of statistics fields returned.
- **data** (object) - An object containing various database statistics:
    - **total** (integer) - Total number of releases in the database.
    - **totalToday** (integer) - Number of releases added today.
    - **totalMonth** (integer) - Number of releases added this month.
    - **totalYear** (integer) - Number of releases added this year.
    - **totalNuked** (integer) - Total number of nuked releases.
    - **totalUnnuked** (integer) - Total number of unnuked releases.
- **time** (string) - The time taken to process the request.

#### Response Example
```json
{
	"status": "success",
	"message": "",
	"results": 5,
	"data": {
		"total": 9483958,
		"totalToday": 1178,
		"totalMonth": 37094,
		"totalYear": 388932,
		"totalNuked": 248438,
		"totalUnnuked": 12659
	},
	"time": "0.0002s"
}
```
```

--------------------------------

### Predb Search API

Source: https://predb.net/api-documentation/index

This endpoint allows you to search for pre-releases based on various criteria. If no parameters are provided, it defaults to the last 20 releases.

```APIDOC
## GET /

### Description
Searches for pre-releases or provides default results.

### Method
GET

### Endpoint
/

### Parameters
#### Query Parameters
- **type** (string) - Optional - Specifies the type of query. Defaults to 'search'.
  - 'search': Returns results matching search parameters (default behavior).
  - 'pre': Requires the 'release' parameter. Returns 1 or 0 results.
  - 'nfo': Requires the 'release' parameter. Returns NFO download and image URL.
  - 'stats': Returns general database statistics.
  - 'nukedstats': Returns general nuked/unnuked related database statistics.
  - 'unnukedstats': Returns general nuked/unnuked related database statistics.
  - 'groupstats': Requires the 'group' parameter. Returns group-related database statistics.
  - 'sectionstats': Requires the 'section' parameter. Returns section-related database statistics.
- **q** (string) - Optional - Search query string.
- **group** (string) - Optional - Filter by release group.
- **section** (string) - Optional - Filter by section.
- **genre** (string) - Optional - Filter by genre.
- **tag** (string) - Optional - Filter by tag.
- **status** (string) - Optional - Filter by release status.
- **page** (int) - Optional - Page number for paginated results (not applicable for 'pre' or 'nfo' types).
- **limit** (int) - Optional - Number of results per page.
- **order_by** (string) - Optional - Field to order results by (e.g., 'release').
- **sort** (string) - Optional - Sort order ('asc' or 'desc').
- **release** (string) - Required for 'pre' and 'nfo' types - The release name to search for.

### Request Example
```json
{
  "example": "GET https://api.predb.net/?q=alien&section=X264&tag=2160p&genre=sci-fi&order_by=release&sort=asc"
}
```
```json
{
  "example": "GET https://api.predb.net/?type=pre&release=Toy.Soldiers.HD-DOGE"
}
```
```json
{
  "example": "GET https://api.predb.net/?type=nfo&release=Toy.Soldiers.HD-DOGE"
}
```
```json
{
  "example": "GET https://api.predb.net/?type=stats"
}
```
```json
{
  "example": "GET https://api.predb.net/?type=groupstats&group=talion"
}
```

### Response
#### Success Response (200)
- **status** (string) - 'error' or 'success'.
- **message** (string) - Message if status is 'error'.
- **data** (array or null) - Array of release objects or null if no results.
- **page** (int) - Current page number (for search results).
- **results** (int) - Number of results found.
- **time** (float) - Execution time in seconds.

**Simple release object within the 'data' array:**
- **id** (int) - Internal unique ID (may change).
- **pretime** (int) - Release timestamp.
- **release** (string) - Release name.
- **section** (string) - Section the release belongs to.
- **files** (int) - Number of files in the release.
- **size** (float) - Release size in MB.
- **status** (int) - Release status (0: ok, 1: nuked, 2: unnuked, 3: delpre, 4: undelpre).
- **reason** (string) - Reason for status change (nuke, unnuke, etc.).
- **group** (string) - Release group.
- **genre** (string) - Release genre.
- **url** (string) - URL to the release on predb.net.
- **nfo** (string) - URL to the NFO file if available.
- **nfo_image** (string) - URL to the NFO image if available.

#### Response Example
```json
{
  "status": "success",
  "data": [
    {
      "id": 12345,
      "pretime": 1678886400,
      "release": "Example.Release.2023.1080p.BluRay.x264-GROUP",
      "section": "Movies",
      "files": 10,
      "size": 5460.50,
      "status": 0,
      "reason": null,
      "group": "GROUP",
      "genre": "HD-Movie",
      "url": "https://predb.net/release/12345",
      "nfo": "https://predb.net/nfo/12345.txt",
      "nfo_image": "https://predb.net/nfo/12345.png"
    }
  ],
  "page": 1,
  "results": 1,
  "time": 0.123
}
```
```

--------------------------------

### NFO and File URL Retrieval (type=nfo)

Source: https://predb.net/api-documentation/index

Retrieves the NFO file and image URL for a specific release.

```APIDOC
## GET /api/search?type=nfo

### Description
Retrieves NFO file and image URLs for a specific release.

### Method
GET

### Endpoint
https://api.predb.net/

### Parameters
#### Query Parameters
- **type** (string) - Required - Must be set to `nfo`.
- **release** (string) - Required - The exact name of the release to retrieve NFO for.

### Request Example
```json
{
  "request": "GET /?type=nfo&release=Example.Release.Name.1080p.BluRay.x264-GROUP"
}
```

### Response
#### Success Response (200)
- **nfo_url** (string) - URL to the NFO file.
- **image_url** (string) - URL to an image representation of the NFO.

#### Response Example
```json
{
  "nfo_url": "https://predb.net/nfo/example_release_name.nfo",
  "image_url": "https://predb.net/img/example_release_name.png"
}
```
```

--------------------------------

### Unnuked Statistics (type=unnukedstats)

Source: https://predb.net/api-documentation/index

Retrieves statistics about unnuked releases.

```APIDOC
## GET /api/search?type=unnukedstats

### Description
Retrieves statistics for unnuked releases.

### Method
GET

### Endpoint
https://api.predb.net/

### Parameters
#### Query Parameters
- **type** (string) - Required - Must be set to `unnukedstats`.
- **group** (string) - Optional - Filter by group name. Supports multiple values (comma-separated) and exclusions (prefixed with '-').
- **section** (string) - Optional - Filter by section name. Supports multiple values (comma-separated) and exclusions (prefixed with '-').

### Request Example
```json
{
  "request": "GET /?type=unnukedstats&section=games"
}
```

### Response
#### Success Response (200)
- **unnuked_count** (integer) - Total number of unnuked releases.
- **unnuked_releases** (array) - Array of unnuked release objects (similar to general search results).

#### Response Example
```json
{
  "unnuked_count": 14950000,
  "unnuked_releases": [
    {
      "pre": "mno345pqr678",
      "name": "Unnuked.Release.Example.REPACK-GROUP",
      "group": "GROUP",
      "size": 800000000,
      "added": 1678880000
    }
  ]
}
```
```

--------------------------------

### Nuked Statistics (type=nukedstats)

Source: https://predb.net/api-documentation/index

Retrieves statistics about nuked releases.

```APIDOC
## GET /api/search?type=nukedstats

### Description
Retrieves statistics for nuked releases.

### Method
GET

### Endpoint
https://api.predb.net/

### Parameters
#### Query Parameters
- **type** (string) - Required - Must be set to `nukedstats`.
- **group** (string) - Optional - Filter by group name. Supports multiple values (comma-separated) and exclusions (prefixed with '-').
- **section** (string) - Optional - Filter by section name. Supports multiple values (comma-separated) and exclusions (prefixed with '-').

### Request Example
```json
{
  "request": "GET /?type=nukedstats&group=CRACKED"
}
```

### Response
#### Success Response (200)
- **nuked_count** (integer) - Total number of nuked releases.
- **nuked_releases** (array) - Array of nuked release objects (similar to general search results).

#### Response Example
```json
{
  "nuked_count": 50000,
  "nuked_releases": [
    {
      "pre": "ghi789jkl012",
      "name": "Nuked.Release.Example.1080p-GROUP",
      "group": "GROUP",
      "size": 500000000,
      "added": 1678000000
    }
  ]
}
```
```

--------------------------------

### Group Statistics

Source: https://predb.net/api-documentation/index

Retrieves statistics specific to a release group, including their first and last releases.

```APIDOC
## GET /?type=groupstats&group={group_name}

### Description
Fetches statistics and details about a specific release group.

### Method
GET

### Endpoint
`/?type=groupstats&group={group_name}`

### Query Parameters
- **type** (string) - Required - Must be set to 'groupstats'.
- **group** (string) - Required - The name of the group to get statistics for.

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the request ('success' or 'error').
- **message** (string) - Contains any error message if the status is 'error'.
- **results** (integer) - The number of statistics fields returned.
- **data** (object) - An object containing group-specific statistics:
    - **group** (string) - The name of the group.
    - **total** (integer) - Total number of releases by this group.
    - **first_pre** (array) - An array containing the details of the group's first release.
    - **last_pre** (array) - An array containing the details of the group's last release.
    Each release object in `first_pre` and `last_pre` contains:
        - **id** (integer) - Unique identifier for the release.
        - **pretime** (integer) - Timestamp of when the release was preed.
        - **release** (string) - The name of the release.
        - **section** (string) - The section the release belongs to.
        - **files** (integer) - The number of files in the release.
        - **size** (integer) - The size of the release in KB.
        - **status** (integer) - Status of the release.
        - **reason** (string) - Reason for the status.
        - **group** (string) - The group that released this release.
        - **genre** (string) - The genre of the release.
        - **url** (string) - A relative URL to the release details.
        - **nfo** (string) - A URL to the NFO file.
        - **nfo_image** (string) - A URL to the NFO image.
- **time** (string) - The time taken to process the request.

#### Response Example
```json
{
	"status": "success",
	"message": "",
	"results": 4,
	"data": {
		"group": "TALiON",
		"total": 69122,
		"first_pre": [
			{
				"id": 2554052,
				"pretime": 1168368514,
				"release": "Markus_Schulz_-_Global_DJ_Broadcast__Incl_Sasha_Guestmix-SBD-12-07-2006-TALiON",
				"section": "MP3",
				"files": 1,
				"size": 172,
				"status": 1,
				"reason": "dupe.GiTS.2006-12-10",
				"group": "TALiON",
				"genre": "",
				"url": "/rls/Markus_Schulz_-_Global_DJ_Broadcast__Incl_Sasha_Guestmix-SBD-12-07-2006-TALiON",
				"nfo": "",
				"nfo_img": ""
			}
		],
		"last_pre": [
			{
				"id": 9744206,
				"pretime": 1689566834,
				"release": "Flux_Pavilion_-_Circus_Records_Takeover-SAT-07-15-2023-TALiON",
				"section": "MP3",
				"files": 1,
				"size": 84,
				"status": 0,
				"reason": "",
				"group": "TALiON",
				"genre": "",
				"url": "/rls/Flux_Pavilion_-_Circus_Records_Takeover-SAT-07-15-2023-TALiON",
				"nfo": "",
				"nfo_img": ""
			}
		]
	},
	"time": "0.0362s"
}
```
```

--------------------------------

### Section Statistics (type=sectionstats)

Source: https://predb.net/api-documentation/index

Retrieves statistics related to a specific section.

```APIDOC
## GET /api/search?type=sectionstats

### Description
Retrieves statistics for a specific section (e.g., movies, games).

### Method
GET

### Endpoint
https://api.predb.net/

### Parameters
#### Query Parameters
- **type** (string) - Required - Must be set to `sectionstats`.
- **section** (string) - Required - The name of the section to get statistics for.

### Request Example
```json
{
  "request": "GET /?type=sectionstats&section=movies"
}
```

### Response
#### Success Response (200)
- **section_name** (string) - The name of the section.
- **release_count** (integer) - Number of releases in this section.
- **total_size** (integer) - Total size of releases in this section in bytes.

#### Response Example
```json
{
  "section_name": "movies",
  "release_count": 8000000,
  "total_size": 8000000000000
}
```
```

--------------------------------

### Group Statistics (type=groupstats)

Source: https://predb.net/api-documentation/index

Retrieves statistics related to a specific group.

```APIDOC
## GET /api/search?type=groupstats

### Description
Retrieves statistics for a specific release group.

### Method
GET

### Endpoint
https://api.predb.net/

### Parameters
#### Query Parameters
- **type** (string) - Required - Must be set to `groupstats`.
- **group** (string) - Required - The name of the group to get statistics for.

### Request Example
```json
{
  "request": "GET /?type=groupstats&group=CODEX"
}
```

### Response
#### Success Response (200)
- **group_name** (string) - The name of the group.
- **release_count** (integer) - Number of releases by this group.
- **total_size** (integer) - Total size of releases by this group in bytes.

#### Response Example
```json
{
  "group_name": "CODEX",
  "release_count": 12000,
  "total_size": 12000000000000
}
```
```
Tokens:
Raw