Skip to content

API.md

Latest commit

 

History

History
111 lines (74 loc) · 2.84 KB

API.md

File metadata and controls

111 lines (74 loc) · 2.84 KB

ArkPlanner API

Request URL: https://planner.penguin-stats.io/plan

Request Method: POST

Post Parameters

  • owned: dict({item_name(str): count(int)})

default: {}

A dict of items owned, where keys are item names, i.e. 'D32钢', values are numbers of items owned.

  • required: dict({item_name(str): count(int)})

default: {}

A dict of items required, where keys are item names, i.e. 'D32钢', values are numbers of items required.

  • extra_outc: boolean

default: False

Whether extra outcome of convertion is considered.

  • convertion_dr: float NEW

default: 0.18

The drop rate of extra outcome.

  • exp_demand: boolean or int

default: True

Whether Battle Record (作战记录) is considered valuable. If True, requirement of Battle Record is set to 1e9. If input is an integer, the requirement of experiment is set to be euqal to the input.

  • gold_demand: boolean or int

default: True

Whether LMD (龙门币) is considered valuable. If True, requirement of LMD is set to 1e9. If False, the value of Pure Gold is also considered 0. If input is an integer, the requirement of LMD is set to be euqal to the input.

  • exclude: list(str)

default: []

Stages banned during calculation. Example: ['1-7', 'SA-5']

  • store: boolean

default: False

Whether to response green and yellow ticket values in stores.

  • input_lang: string NEW
  • output_lang: string NEW

Languages of input and output data. Available Languages: ['zh', 'en', 'ja', 'ko'], and 'id' for item ids. Default value: input_lang = 'zh', output_lang = 'zh'

  • server: string NEW

Using active stages from this server. Available Servers: ['CN', 'US', 'JP', 'KR']. Default value: server = 'CN'

Response Parameters

  • cost : int

Expected sanity cost.

  • gcost : int

Expected gold cost in convertion.

  • gold : int

Expected gold gain in farming.

  • exp : int

Expected exp gain in farming. Pure Gold not included.

  • stages: list(stage)
stage = {
   'stage': str, # stage name, eg. '1-7'
   'count': int, # times to farm
   'items': dict{str: int} # item_name: item_count
}

Stages recommended to farm.

  • syntheses: list(synthesis)
synthesis= {
   'target': str, # target item name
   'count': int, # times to convert
   'materials': dict{str: int} # converted_item_name: item_count
}

Convertions recommended.

  • values: dict {level (str): value (dict) }
value = {
	'name': str, # item name
	'value': float # item value
}

Item values.

  • green: dict {item (str): value (float) }
  • yellow: dict {item (str): value (float) }

Value of one piece of green/yellow ticket when buying target items in the store.