Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sylveondeko/nhentaiapi
A (full) nHentai API implementation for .NET
https://github.com/sylveondeko/nhentaiapi
andy840119 api hentai n-hentai nhentai nhentai-api nuget
Last synced: 5 days ago
JSON representation
A (full) nHentai API implementation for .NET
- Host: GitHub
- URL: https://github.com/sylveondeko/nhentaiapi
- Owner: SylveonDeko
- License: mit
- Created: 2018-12-07T07:43:03.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-15T18:55:54.000Z (3 months ago)
- Last Synced: 2025-01-29T10:29:58.265Z (6 days ago)
- Topics: andy840119, api, hentai, n-hentai, nhentai, nhentai-api, nuget
- Language: C#
- Size: 84 KB
- Stars: 34
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NHentaiAPI
[](https://ci.appveyor.com/project/SylveonDeko/nhentaiapi)
[](https://www.nuget.org/packages/NHentaiAPI)
[](https://www.nuget.org/packages/NHentaiAPI)
[](https://github.com/SylveonDeko/NHentaiAPI)
A full nHentai API implementation for .NET
⚠️ If nHentai changes their API format, please create an issue to let me know!
## Important Notes
### User Agent Requirements
A User-Agent is **required** to use this API. The client will throw an error if none is provided. You can get your User-Agent by:
1. Going to https://www.whatismybrowser.com/detect/what-is-my-user-agent/
2. Or by opening Developer Tools (F12) in your browser, going to Network tab, and looking at the "User-Agent" header in any request
Example:
```csharp
var client = new NHentaiClient("Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36");
```
### CSRF Token (If Required)
If nHentai implements CSRF protection, you can get the token by:
1. Opening Developer Tools (F12)
2. Going to Network tab
3. Looking for a request header named 'x-csrf-token' or a cookie named 'csrf_token'
4. Pass it to the client using the cookies dictionary
**Important**: The CSRF token must be obtained from the same IP address and User-Agent that will be used with the API. Using a token from a different IP or User-Agent will result in authentication failures.
```csharp
var cookies = new Dictionary
{
{"csrf_token", "your-token-here"}
};
var client = new NHentaiClient("your-user-agent", cookies);
```
## Features
### Search Capabilities:
1. Browse homepage content
2. Search by keywords
3. Search by tags with optional popularity sorting
4. Filter tags using `-` prefix (exclusion)
### Book Operations:
1. Fetch book details
2. Get related books
### Image Operations:
1. Page images (preview, thumbnail, and original quality)
2. Cover images (preview and thumbnail)
## Usage Examples
### Search Books:
```csharp
// Initialize client with User-Agent
var client = new NHentaiClient("your-user-agent-string");
// Search with filters
var result = await client.GetSearchPageListAsync("school swimsuit full color -loli", 2);
// Browse homepage
var homeResults = await client.GetHomePageListAsync(1);
```
### Get Book Details:
```csharp
var client = new NHentaiClient("your-user-agent-string");
// Get book by ID
var book = await client.GetBookAsync(123);
// Get related books
var related = await client.GetBookRecommendAsync(123);
```
### Get Images:
```csharp
var book = await client.GetBookAsync(123);
// Get full page image
byte[] picture = await client.GetPictureAsync(book, 1);
// Get cover image
byte[] cover = await client.GetBigCoverPictureAsync(book);
// Get thumbnails
byte[] thumbnail = await client.GetThumbPictureAsync(book, 1);
byte[] coverThumb = await client.GetBookThumbPictureAsync(book);
```
## Check Out My Other Projects
- [Mewdeko](https://github.com/SylveonDeko/Mewdeko) - Discord Bot
- [MartineApi](https://github.com/SylveonDeko/MartineApi.Net) - Image API Wrapper
- [NekosBestApi](https://github.com/SylveonDeko/Nekos.Best-API) - Anime Image API
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.