Skip to content

Latest commit

 

History

History
130 lines (92 loc) · 4.87 KB

GameApi.md

File metadata and controls

130 lines (92 loc) · 4.87 KB
Raw

dofusdude.GameApi

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

Method HTTP request Description
getGameSearch GET /{game}/{language}/search Game Search
getItemsAllSearch GET /{game}/{language}/items/search Search All Items

getGameSearch

[GetGameSearch200ResponseInner] getGameSearch(language, game, query, opts)

Game Search

Search in all names and descriptions of all supported types in the game. For the list of supported types see the endpoint /dofus2/meta/search/types.

Example

import dofusdude from 'dofusdude-js';

let apiInstance = new dofusdude.GameApi();
let language = "language_example"; // String | a valid language code
let game = "dofus2"; // String | 
let query = "paztek"; // String | search query
let opts = {
  'filterType': ["null"], // [String] | only results with all specific type
  'limit': 8, // Number | maximum number of returned results
  'fieldsItem': ["null"], // [String] | adds fields from the item search to the list entries if the hit is a item. Multiple comma separated values allowed.
  'filterTypeEnum': ["null"] // [String] | multi-filter results with the english item type name, including \"mount\" and \"set\" from filter[type]. Add with \"wood\" or \"+wood\" and exclude with \"-wood\".
};
apiInstance.getGameSearch(language, game, query, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
language String a valid language code
game String
query String search query
filterType [String] only results with all specific type [optional]
limit Number maximum number of returned results [optional] [default to 8]
fieldsItem [String] adds fields from the item search to the list entries if the hit is a item. Multiple comma separated values allowed. [optional]
filterTypeEnum [String] multi-filter results with the english item type name, including "mount" and "set" from filter[type]. Add with "wood" or "+wood" and exclude with "-wood". [optional]

Return type

[GetGameSearch200ResponseInner]

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getItemsAllSearch

[ItemsListEntryTyped] getItemsAllSearch(language, game, query, opts)

Search All Items

Search in all names and descriptions of Dofus items (including all subtypes) with a query.

Example

import dofusdude from 'dofusdude-js';

let apiInstance = new dofusdude.GameApi();
let language = "fr"; // String | a valid language code
let game = "dofus2"; // String | 
let query = "atcham"; // String | case sensitive search query
let 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
  'limit': 8, // Number | maximum number of returned results
  'filterTypeEnum': ["null"] // [String] | multi-filter results with the english type name. Add with \"wood\" or \"+wood\" and exclude with \"-wood\".
};
apiInstance.getItemsAllSearch(language, game, query, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
language String a valid language code
game String
query String case sensitive search query
filterTypeName String only results with the translated type name across all item_subtypes [optional]
filterMinLevel Number only results which level is equal or above this value [optional]
filterMaxLevel Number only results which level is equal or below this value [optional]
limit Number maximum number of returned results [optional] [default to 8]
filterTypeEnum [String] multi-filter results with the english type name. Add with "wood" or "+wood" and exclude with "-wood". [optional]

Return type

[ItemsListEntryTyped]

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json