API Documentation Github stalks.io

Title

Global

Type Definitions

Object

# AdviceData

Properties:
Name Type Description
sell boolean A boolean indicating if you should sell or hold.
advice string Isabelle's friendly advice for your current situation.
prediction PredictionData The projected forecasts for your stalk market.
odds Object.<string, number> A dictionary consisting of price/odds mappings. Each key corresponds to a possible price, and the value is the likelihood that you'll hit that price.

View Source structures/stalks/weeks/AdviceData.jsdoc, line 1

Object

# BuyData

Properties:
Name Type Attributes Description
local boolean Indicating whether the turnips were purchased locally.
label string <optional>
 String to mark where the turnips were purchased from.
price number Buy price of the turnips (between 90 and 110, inclusive).
quantity number The number of turnips purchased.

View Source structures/stalks/weeks/BuyData.jsdoc, line 1

Date | string

# DateResolvable

A date that can be either a Date or a string.

View Source additional_docs/DateResolvable.jsdoc, line 1

Object

# FriendWeekData

Properties:
Name Type Description
id number The id of the friend.
username string The username of the friend.
prices Array.<number> A list of prices for each slot. null values can be used for missing prices.
advice AdviceData Advice for the friend.

View Source structures/stalks/weeks/FriendWeekData.jsdoc, line 1

Object

# PassportData

Properties:
Name Type Attributes Description
username string <optional>
 The username of a user.
villager_name string <optional>
 The villager name of a user.
town_name string <optional>
 The town/island name of a user.
friend_code string <optional>
 The friend code of a user. Format: SW-1234-5678-0910
bought_local boolean <optional>
 Whether your island has ever had turnips bought from it.
patron_lowkey boolean <optional>
 Whether to hide you from the patrons page.

View Source structures/accounts/passport/PassportData.jsdoc, line 1

Passport | PassportData

# PassportResolvable

A passport that can be either a passport object or just some passport data.

View Source structures/accounts/passport/PassportResolvable.jsdoc, line 1

Object

# PredictionData

The dictionaries contain the detected patterns, along with the price ranges that each pattern could hit in each slot. The range is defined as a list of tow prices, where the first is the lowest possible, and the second is the highest possible.
Properties:
Name Type Description
possible Object.<Object.<Array.<Array.<number, number>>>>
likely Object.<Object.<Array.<Array.<number, number>>>>

View Source structures/stalks/weeks/PredictionData.jsdoc, line 1

Object

# ProfileData

Properties:
Name Type Attributes Description
id number The ID of a user.
username string The username of a user.
villager_name string <nullable>
 The villager name the user entered in his passport.
town_name string <nullable>
 The town/island name the user entered in his passport.
patron_level number <nullable>
 The patron level a user has.
weeks Array.<WeekData> The weeks of a user.

View Source structures/accounts/profile/ProfileData.jsdoc, line 1

string | Profile

# ProfileResolvable

A profile that can be either an id, a username or a Profile.

View Source structures/accounts/profile/ProfileResolvable.jsdoc, line 1

Object

# SellData

Properties:
Name Type Description
price number Sell price of the turnips.
quantity number Number of turnips sold.
slots number The number of slots were filled when the sale was made.

View Source structures/stalks/weeks/SellData.jsdoc, line 1

Object

# WeekData

Properties:
Name Type Attributes Description
id number <optional>
 The id of the week.
date string The sunday that the week started on.
buys Array.<BuyData> The list of buys were made.
To indicate that there haven't been any buys yet, simply send an empty list.
buy_local_first_time boolean <nullable>
 Whether or not this is the first that turnips have been bought from your island.
sells Array.<SellData> Just like buys, this is a list because you can track multiple sales.
local_price number <nullable>
 The price Daisy Mae was selling turnips for on your specific island, regardless of where you purchased from.
prices Array.<number> A list of prices for each slot. null values can be used for missing prices.
previous_pattern string <optional>
 (read only) The pattern you had last week.
manual_previous_pattern string <optional>
 Allows you to explicitly state what your pattern was last week.
Should be one of "big_spike", "small_spike", "triple", or "decreasing".
profit number <optional>
 (read only) Your calculated profit for the week.
advice AdviceData <optional>
 (read only) Contains all of your predictions and suggestions for the week, based on what you've entered.
friend_weeks Array.<FriendWeekData> <optional>
 A list of all your friends that have entered data for the corresponding week.
version number <optional>
 A sanity check that prevents an outdated frontend from overwriting newer data on the server.

View Source structures/stalks/weeks/WeekData.jsdoc, line 1