MangaDex 5.13.1.3

MangaDex - the C# library for the MangaDex API

MangaDex is an ad-free manga reader offering high-quality images!

This document details our API as it is right now. It is in no way a promise to never change it, although we will endeavour to publicly notify any major change.

Acceptable use policy

Usage of our services implies acceptance of the following:

• You MUST credit us
• You MUST credit scanlation groups if you offer the ability to read chapters
• You CANNOT run ads or paid services on your website and/or apps

These may change at any time for any and no reason and it is up to you check for updates from time to time.

Security issues

If you believe you found a security issue in our API, please check our security.txt to get in touch privately.

This C# SDK is a hand-maintained client for the MangaDex API, built on Refit and System.Text.Json. It is kept in sync with the MangaDex OpenAPI specification (api/openapi-<version>.yaml, one file per API version — the highest version is current) manually — updates are applied directly to the source.

• API version: 5.13.1
• SDK version: 5.13.1 (tracks the API version; a 4th revision component — e.g. 5.13.1.1 — denotes client-only fixes)
• Source specification: api/openapi-5.13.1.yaml

<a id="frameworks-supported"></a>

Frameworks supported

• .NET 10.0
• .NET Framework 4.8

<a id="dependencies"></a>

Dependencies

• System.Text.Json - 10.0.9 or later
• Refit - 13.1.0 or later
• System.ComponentModel.Annotations - 5.0.0 or later

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package System.Text.Json
Install-Package Refit
Install-Package System.ComponentModel.Annotations

<a id="installation"></a>

Installation

Generate the DLL using your preferred tool (e.g. dotnet build)

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using MangaDex.Api;         // the Refit interfaces (IMangaApi, IChapterApi, ...)
using MangaDex.Client;      // SerializerOptions
using MangaDex.Model;
using Refit;

This client is a set of Refit interfaces. You build a client with an HttpClient and RefitSettings that reuses the library's System.Text.Json options; auth and proxying are configured on the HttpClient/HttpClientHandler.

<a id="usage"></a>

Usage

To route through an HTTP proxy (and add a bearer token), configure the HttpClient:

var handler = new HttpClientHandler
{
    Proxy = new System.Net.WebProxy("http://myProxyUrl:80/"),
    UseProxy = true,
};
var http = new HttpClient(handler) { BaseAddress = new Uri("https://api.mangadex.org") };
http.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token);

<a id="getting-started"></a>

Getting Started

using System;
using System.Diagnostics;
using System.Net.Http;
using MangaDex.Api;
using MangaDex.Client;
using Refit;

namespace Example
{
    public class Example
    {
        public static async System.Threading.Tasks.Task Main()
        {
            var settings = new RefitSettings(
                new SystemTextJsonContentSerializer(SerializerOptions.Default));

            var http = new HttpClient { BaseAddress = new Uri("https://api.mangadex.org") };
            var infrastructure = RestService.For<IInfrastructureApi>(http, settings);

            try
            {
                // Ping healthcheck
                string result = await infrastructure.GetPing();
                Debug.WriteLine(result);
            }
            catch (ApiException e)  // Refit.ApiException
            {
                Debug.Print("Exception when calling IInfrastructureApi.GetPing: " + e.Message);
                Debug.Print("Status Code: " + (int)e.StatusCode);
            }
        }
    }
}

<a id="documentation-for-authorization"></a>

Documentation for Authorization

Authentication schemes defined for the API: <a id="Bearer"></a>

Bearer

• Type: Bearer Authentication