Rust API client for dofusdude

Open Ankama Developer Community

The all-in-one toolbelt for your next Ankama related project.

Versions

• Dofus 2
• Dofus 3
  • v1 [latest] (you are here)

Client SDKs

• Javascript npm i dofusdude-js --save
• Typescript npm i dofusdude-ts --save
• Go go get -u github.com/dofusdude/dodugo
• Python pip install dofusdude
• Java Maven with GitHub packages setup

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 10 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 🇩🇪.

• 📨 Almanax Discord Integration Use the endpoints as a dev or the official Web Client as a user.

• 🩸 Dofus 3 Beta from stable to bleeding edge by replacing /dofus3 with /dofus3beta.

• 🗣️ Multilingual supporting en, fr, es, pt, de.

• 🧠 Search by Relevance allowing typos in name and description, handled by language specific text analysis and indexing.

• 🕵️ Official Sources generated from actual data from the game.

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

For more information, please visit https://discord.gg/3EtHskZD8h

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

• API version: 1.0.0
• Package version: 1.0.0-beta.1
• Generator version: 7.18.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named dofusdude and add the following to Cargo.toml under [dependencies]:

dofusdude = { path = "./dofusdude" }

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AlmanaxApi	get_almanax_date	GET /dofus3/v1/{language}/almanax/{date}	Single Almanax Date
AlmanaxApi	get_almanax_range	GET /dofus3/v1/{language}/almanax	Almanax Range
ConsumablesApi	get_all_items_consumables_list	GET /{game}/v1/{language}/items/consumables/all	List All Consumables
ConsumablesApi	get_items_consumables_list	GET /{game}/v1/{language}/items/consumables	List Consumables
ConsumablesApi	get_items_consumables_search	GET /{game}/v1/{language}/items/consumables/search	Search Consumables
ConsumablesApi	get_items_consumables_single	GET /{game}/v1/{language}/items/consumables/{ankama_id}	Single Consumables
CosmeticsApi	get_all_cosmetics_list	GET /{game}/v1/{language}/items/cosmetics/all	List All Cosmetics
CosmeticsApi	get_cosmetics_list	GET /{game}/v1/{language}/items/cosmetics	List Cosmetics
CosmeticsApi	get_cosmetics_search	GET /{game}/v1/{language}/items/cosmetics/search	Search Cosmetics
CosmeticsApi	get_cosmetics_single	GET /{game}/v1/{language}/items/cosmetics/{ankama_id}	Single Cosmetics
EquipmentApi	get_all_items_equipment_list	GET /{game}/v1/{language}/items/equipment/all	List All Equipment
EquipmentApi	get_items_equipment_list	GET /{game}/v1/{language}/items/equipment	List Equipment
EquipmentApi	get_items_equipment_search	GET /{game}/v1/{language}/items/equipment/search	Search Equipment
EquipmentApi	get_items_equipment_single	GET /{game}/v1/{language}/items/equipment/{ankama_id}	Single Equipment
GameApi	get_game_search	GET /{game}/v1/{language}/search	Game Search
GameApi	get_items_all_search	GET /{game}/v1/{language}/items/search	Search All Items
MetaApi	get_game_search_types	GET /{game}/v1/meta/search/types	Available Game Search Types
MetaApi	get_item_types	GET /{game}/v1/meta/items/types	Available Item Types
MetaApi	get_meta_almanax_bonuses	GET /dofus3/v1/meta/{language}/almanax/bonuses	Available Almanax Bonuses
MetaApi	get_meta_almanax_bonuses_search	GET /dofus3/v1/meta/{language}/almanax/bonuses/search	Search Available Almanax Bonuses
MetaApi	get_meta_elements	GET /{game}/v1/meta/elements	Effects and Condition Elements
MetaApi	get_meta_version	GET /{game}/v1/meta/version	Game Version
MountsApi	get_all_mounts_list	GET /{game}/v1/{language}/mounts/all	List All Mounts
MountsApi	get_mounts_list	GET /{game}/v1/{language}/mounts	List Mounts
MountsApi	get_mounts_search	GET /{game}/v1/{language}/mounts/search	Search Mounts
MountsApi	get_mounts_single	GET /{game}/v1/{language}/mounts/{ankama_id}	Single Mounts
QuestItemsApi	get_all_items_quest_list	GET /{game}/v1/{language}/items/quest/all	List All Quest Items
QuestItemsApi	get_item_quest_single	GET /{game}/v1/{language}/items/quest/{ankama_id}	Single Quest Items
QuestItemsApi	get_items_quest_list	GET /{game}/v1/{language}/items/quest	List Quest Items
QuestItemsApi	get_items_quest_search	GET /{game}/v1/{language}/items/quest/search	Search Quest Items
ResourcesApi	get_all_items_resources_list	GET /{game}/v1/{language}/items/resources/all	List All Resources
ResourcesApi	get_items_resource_search	GET /{game}/v1/{language}/items/resources/search	Search Resources
ResourcesApi	get_items_resources_list	GET /{game}/v1/{language}/items/resources	List Resources
ResourcesApi	get_items_resources_single	GET /{game}/v1/{language}/items/resources/{ankama_id}	Single Resources
SetsApi	get_all_sets_list	GET /{game}/v1/{language}/sets/all	List All Sets
SetsApi	get_sets_list	GET /{game}/v1/{language}/sets	List Sets
SetsApi	get_sets_search	GET /{game}/v1/{language}/sets/search	Search Sets
SetsApi	get_sets_single	GET /{game}/v1/{language}/sets/{ankama_id}	Single Sets
WebhooksApi	delete_webhooks_almanax_id	DELETE /webhooks/almanax/{id}	Unregister Almanax Hook
WebhooksApi	delete_webhooks_rss_id	DELETE /webhooks/rss/{id}	Unregister RSS Hook
WebhooksApi	delete_webhooks_twitter_id	DELETE /webhooks/twitter/{id}	Unregister Twitter Hook
WebhooksApi	get_meta_webhooks_almanax	GET /meta/webhooks/almanax	Get Almanax Hook Metainfo
WebhooksApi	get_meta_webhooks_rss	GET /meta/webhooks/rss	Get RSS Hook Metainfo
WebhooksApi	get_meta_webhooks_twitter	GET /meta/webhooks/twitter	Get Twitter Hook Metainfo
WebhooksApi	get_webhooks_almanax_id	GET /webhooks/almanax/{id}	Get Almanax Hook
WebhooksApi	get_webhooks_rss_id	GET /webhooks/rss/{id}	Get RSS Hook
WebhooksApi	get_webhooks_twitter_id	GET /webhooks/twitter/{id}	Get Twitter Hook
WebhooksApi	post_webhooks_almanax	POST /webhooks/almanax	Register Almanax Hook
WebhooksApi	post_webhooks_rss	POST /webhooks/rss	Register RSS Hook
WebhooksApi	post_webhooks_twitter	POST /webhooks/twitter	Register Twitter Hook
WebhooksApi	put_webhooks_almanax_id	PUT /webhooks/almanax/{id}	Update Almanax Hook
WebhooksApi	put_webhooks_rss_id	PUT /webhooks/rss/{id}	Update RSS Hook
WebhooksApi	put_webhooks_twitter_id	PUT /webhooks/twitter/{id}	Update Twitter Hook

Documentation For Models

• Almanax
• AlmanaxBonus
• AlmanaxTribute
• AlmanaxTributeItem
• AlmanaxWebhook
• AlmanaxWebhookDailySettings
• Condition
• ConditionLeaf
• ConditionNode
• ConditionRelation
• CreateAlmanaxWebhook
• CreateAlmanaxWebhookDailySettings
• CreateAlmanaxWebhookMentionsValueInner
• CreateRssWebhook
• CreateTwitterWebhook
• Effect
• EffectType
• Equipment
• EquipmentSet
• Error
• GameSearch
• GameSearchItem
• GameSearchType
• GetMetaAlmanaxBonuses200ResponseInner
• GetMetaWebhooksTwitter200Response
• Images
• ItemSubtype
• ListEquipmentSet
• ListEquipmentSets
• ListItem
• ListItemGeneral
• ListItems
• ListMounts
• Mount
• MountFamily
• PagedLinks
• PutAlmanaxWebhook
• PutRssWebhook
• PutTwitterWebhook
• Range
• Recipe
• Resource
• RssWebhook
• TranslatedId
• TwitterWebhook
• Version
• Weapon

To get access to the crate's generated documentation, use:

cargo doc --open

Author

[email protected]