openapilibrary v0.7.0

dofusdude-js

dofusdude - JavaScript client for dofusdude-js

A project for you - the developer.

The free, always-up-to-date, low-latency, insert-buzzword-here Ankama API for your next cool project!

Client SDKs

Don't write types or functions yourself - I already (kinda) did! 😉

• Javascript npm i dofusdude-js --save
• Typescript npm i dofusdude-ts --save
• Go go get -u github.com/dofusdude/dodugo
• Python pip install dofusdude

Everything, including this site, is generated out of the Docs Repo. Consider it the Single Source of Truth. If there is a problem with the SDKs, create an issue there.

Your favorite language is missing? Please let me know!

Main Features

• 🥷 Seamless Auto-Update load data in the background when a new Dofus version is released and serving it within 2 minutes with atomic data source switching. No downtime and no effects for the user, just always up-to-date.

• ⚡ Blazingly Fast all data in-memory, aggressive caching over short time spans, HTTP/2 multiplexing, written in Go, optimized for low latency, hosted on bare metal in 🇩🇪.

• 📨 Discord Integration Ankama related Twitter, RSS and Almanax feeds to post to Discord servers with advanced features like filters or mentions. Use the endpoints as a dev or the official Web Client as a user.

• 🩸 Dofus 2 Beta from stable to bleeding edge by replacing /dofus2 with /dofus2beta.

• 🗣️ Multilingual supporting en, fr, es, pt including the dropped languages from the Dofus website de and it.

• 🧠 Search by Relevance allowing typos in name and description, handled by language specific text analysis and indexing by the powerful Meilisearch written in Rust.

• 🕵️ Complete actual data from the game including items invisible to the encyclopedia like quest items.

• 🖼️ HD Images rendering vector graphics into PNGs up to 800x800 px in the background.

Current state

• Weapons ✅
• Equipment ✅
• Sets ✅
• Resources ✅
• Consumables ✅
• Pets ✅
• Mounts ✅
• Cosmetics/Ceremonial Items ✅
• Harnesses ✅
• Quest Items ✅
• Almanax ✅
• Monsters ❌
• Spells ❌

... and much more on the Roadmap on my Discord.

Deploy now. Use forever.

Everything you see here on this site, you can use now and forever. Updates could introduce new fields, new paths or parameter but never break backwards compatibility, so no field or parameter will be deleted.

There is one exception! The API will always choose being up-to-date over everything else. So if Ankama decides to drop languages from the game like they did with their website, the API will loose support for them, too.

Only the beginning... 🤯

I want this project to be useful and not just add plain GET-categories no one needs.

There is a long list of features I want to add (see the Roadmap on my Discord). But they are all focussed on you, the developers. So please let me know what you need. I will change the list based on demand.

Get started! 🥳

Scroll down and try it for yourself!

Or see how these other awesome projects use it:

• KaellyBot by Kaysoro
• Dofus Craftlist by Lystina
• AlmanaxApp by Lystina
• luwnarya.fr

I highly recommend using the SDKs for quick results. I use them myself for microservices for the API.

Thank you!

I highly welcome everyone on my Discord to just talk about projects and use cases or give feedback of any kind.

The servers have a fixed monthly cost to provide very fast responses. If you want to help me keeping them running or simply donate, consider becoming a GitHub Sponsor.

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 0.7.0
• Package version: 0.7.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://discord.gg/3EtHskZD8h

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install dofusdude-js --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your dofusdude-js from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var dofusdude = require('dofusdude-js');


var api = new dofusdude.AllItemsApi()
var language = "language_example"; // {String} a valid language code
var game = dofus2; // {String} 
var query = atcham; // {String} case sensitive search query
var opts = {
  'filterTypeName': Bottes, // {String} only results with the translated type name across all item_subtypes
  'filterMinLevel': 190, // {Number} only results which level is equal or above this value
  'filterMaxLevel': 200 // {Number} only results which level is equal or below this value
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getItemsAllSearch(language, game, query, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://api.dofusdu.de

Documentation for Models

• dofusdude.AlmanaxEntry
• dofusdude.AlmanaxEntryBonus
• dofusdude.AlmanaxEntryTribute
• dofusdude.AlmanaxEntryTributeItem
• dofusdude.AlmanaxWebhook
• dofusdude.AlmanaxWebhookDailySettings
• dofusdude.ConditionEntry
• dofusdude.Cosmetic
• dofusdude.CreateAlmanaxWebhook
• dofusdude.CreateAlmanaxWebhookDailySettings
• dofusdude.CreateAlmanaxWebhookMentionsValueInner
• dofusdude.CreateRSSWebhook
• dofusdude.CreateTwitterWebhook
• dofusdude.EffectsEntry
• dofusdude.EffectsEntryType
• dofusdude.Equipment
• dofusdude.EquipmentParentSet
• dofusdude.EquipmentSet
• dofusdude.GetMetaAlmanaxBonuses200ResponseInner
• dofusdude.GetMetaWebhooksTwitter200Response
• dofusdude.ImageUrls
• dofusdude.ItemListEntry
• dofusdude.ItemsListEntryTyped
• dofusdude.ItemsListEntryTypedType
• dofusdude.ItemsListPaged
• dofusdude.LinksPaged
• dofusdude.Mount
• dofusdude.MountListEntry
• dofusdude.MountsListPaged
• dofusdude.PutAlmanaxWebhook
• dofusdude.PutRSSWebhook
• dofusdude.PutTwitterWebhook
• dofusdude.RecipeEntry
• dofusdude.Resource
• dofusdude.RssWebhook
• dofusdude.SetListEntry
• dofusdude.SetsListPaged
• dofusdude.TwitterWebhook
• dofusdude.Weapon
• dofusdude.WeaponRange

Documentation for Authorization

All endpoints do not require authorization.