An open API service indexing awesome lists of open source software.

https://github.com/yash-garg/nyaa-api-go

Nyaa Search API Written in Go
https://github.com/yash-garg/nyaa-api-go

api golang nyaa-api nyaa-magnet-links nyaa-si torrents

Last synced: 9 months ago
JSON representation

Nyaa Search API Written in Go

Awesome Lists containing this project

README

          

# Nyaa-Api-Go [![Better Uptime Badge](https://betteruptime.com/status-badges/v1/monitor/dkw3.svg)](https://status.yashgarg.dev/)

This API is an **Unofficial Nyaa API** used for searching torrents.

Made for fun, you can use [Nyaa API](https://github.com/Vivek-Kolhe/Nyaa-API) by [@Vivek-Kolhe](https://github.com/Vivek-Kolhe/) instead if you want more endpoints.

## Usage

- `username` and `id` are required parameters if using `/user/{username}` and `/id/{id}` endpoints.

- If no parameters are specified in other endpoints like `/anime`, `/manga`, etc. It will return the latest uploaded torrents in the respective category.

- For Filters, input `filter=1` for *No Remakes* and `filter=2` for *Trusted Only*.

- #### Available Endpoints
| **Arguments** | **Description** |
|------|------|
| `q` **(Optional)** | Search query. |
| `s` **(Optional)** | Sorting parameter |
| `p` **(Optional)** | Page number |
| `f` **(Optional)** | Filter option |
| `o` **(Optional)** | Order of sorting. Defaults to **_Descending order_**. |

- **Endpoints**
| **Category** | **Endpoint** |
|---------|---------|
| All | `/all` |
| Anime | `/anime` |
| Manga | `/manga` |
| Audio | `/audio` |
| Pictures | `/pictures` |
| Live Action | `/live_action` |
| Software | `/software` |
| ID | `/id` |
| User | `/user` |

- **Sub-Categories** (Not applicable for `/user` and `/id`)
| **Category** | **Sub-Category** |
|------|------|
| Anime | `/amv`, `/eng`, `/non-eng`, `/raw` |
| Manga | `/eng`, `/non-eng`, `/raw` |
| Audio | `/lossy`, `/lossless` |
| Pictures | `/photos`, `/graphics` |
| Live Action | `/promo`, `/eng`, `/non-eng`, `/raw` |
| Software | `/application`, `/games` |

- **Sorting Parameters**
| **Arguments** | **Methods** |
| ---- | ---- |
| Sort | `size`, `seeders`, `leechers`, `date`, `downloads` |
| Order | `asc`, `desc` |

- #### Search using ID
- `https://nyaa-api-go.herokuapp.com/id/{id}`

- #### Search using category
- `https://nyaa-api-go.herokuapp.com/{category}?q={search_query}`
- `https://nyaa-api-go.herokuapp.com/{category}?q={search_query}&s={sorting_parameter}`
- `https://nyaa-api-go.herokuapp.com/{category}?q={search_query}&s={sorting_parameter}&p={page_number}`
- `https://nyaa-api-go.herokuapp.com/{category}?q={search_query}&s={sorting_parameter}&p={page_number}&o={order}`
- `https://nyaa-api-go.herokuapp.com/{category}?q={search_query}&s={sorting_parameter}&p={page_number}&o={order}&f={filter}`

- #### Search using sub category
- `https://nyaa-api-go.herokuapp.com/{category}/{sub_category}?q={search_query}`
- `https://nyaa-api-go.herokuapp.com/{category}/{sub_category}?q={search_query}&s={sorting_parameter}`
- `https://nyaa-api-go.herokuapp.com/{category}/{sub_category}?q={search_query}&s={sorting_parameter}&p={page_number}`
- `https://nyaa-api-go.herokuapp.com/{category}/{sub_category}?q={search_query}&s={sorting_parameter}&p={page_number}&o={order}`
- `https://nyaa-api-go.herokuapp.com/{category}/{sub_category}?q={search_query}&s={sorting_parameter}&p={page_number}&o={order}&f={filter}`

- #### Search using username
- `https://nyaa-api-go.herokuapp.com/user/{username}`
- `https://nyaa-api-go.herokuapp.com/user/{username}?q={search_query}`
- `https://nyaa-api-go.herokuapp.com/user/{username}?q={search_query}&s={sorting_parameter}`
- `https://nyaa-api-go.herokuapp.com/user/{username}?q={search_query}&s={sorting_parameter}&p={page_number}`
- `https://nyaa-api-go.herokuapp.com/user/{username}?q={search_query}&s={sorting_parameter}&p={page_number}&o={order}`
- `https://nyaa-api-go.herokuapp.com/user/{username}?q={search_query}&s={sorting_parameter}&p={page_number}&o={order}&f={filter}`