fall-guys-api-fixed

    1.0.1 • Public • Published

    fallguys-api (fixed)

    Not affiliated with Fall Guys.

    All data is taken from fallguys.esportinfo.gg and fallguys.com

    Installation

    install package

    npm install fallguys-api-fixed
    

    require package in project

    const fallguys = require('fallguys-api-fixed');

    FallGuys

    crownIcon

    The icon of the crown

    kudosIcon

    The icon of the kudos

    getAchievements()

    Get all achievements

    getArticles()

    Get all articles

    getColors()

    Get all skins colors

    getEmotes()

    Get all emotes

    getNicknames()

    Get all nicknames

    getNameplates()

    Get all nameplates

    getSeasonpass()

    Get all items of a specific season pass

    getCelebrations()

    Get all Celebrations

    getFaces()

    Get all skins faces

    getFreeSkins()

    Get all "free" (skins who don't need crown or kudos) skins

    getPatterns()

    Get all skins patterns

    getSkins()

    Get all skins

    getDaily()

    Get daily skins

    Achievement

    name

    The name of the achievement (example: Fall Throttle)

    trophyName

    the trophy name of the achievement (example: ACH_FALL_THROTTLE)

    description

    the description of the achievement (example: Reach terminal velocity)

    icon

    the icon of the achievement (preview: )

    grayIcon

    the gray icon of the achievement (preview: )

    Article

    name

    The name of the article (example: 1/Fall Guys First Patch Notes)

    createdAt

    The creation date of the article

    title

    The title of the article (example: Fall Guys Patch Notes 1.0)

    content

    The content of the article (in HTML)

    thumbnail

    The thumbnail of the article (preview: )

    description

    The description of the article (example: Fall Guys: First Patch, new level: Jump Showdown added and plenty of bugs fixed.)

    Color, Emote, Celebration, Face, FreeSkin, Pattern, Nameplate, Nickname

    name

    The name of the skin (example: Raptor)

    img (not in Nickname)

    The img of the skin (preview: )

    rarity

    The rarity of the skin (all rarity: Legendary, Epic, Rare, Uncommon, Common)

    acquire

    Where the skin is obtainable (all acquire: Store, Starter, Rewards, DLC, Battle Pass, Leaked)
    if acquire is DLC or Store you have the price and the currency (Crown, Kudos, USD)
    if acquire is Battle Pass you have the season and the tier

    Skin

    name

    The name of the skin (example: Raptor)

    uid

    Add an id for detect daily store change (only on Daily)

    upperImg

    The upper img of the skin (preview: )

    lowerImg

    The upper img of the skin (preview: )

    rarity

    The rarity of the skin (all rarity: Legendary, Epic, Rare, Uncommon, Common)

    acquire

    Where the skin is obtainable (all acquires: Store, Starter, Rewards, DLC, Battle Pass, Leaked)
    if acquire is DLC or Store you have the price and the currency (Crown, Kudos, USD)
    if acquire is Battle Pass you have the season and the tier

    Daily

    pcStore

    The array for all skin in the pc store

    ps4Store

    The array for all skin in the ps4 store

    Round

    name

    The name of the round (example: Dizzy Heights)

    description

    The description of the round

    goal

    How to finish the round (for Team and Final type)

    size

    The size of the round (all sizes: Small, Medium, Large)

    type

    The type of the round (all types: Race, Survival, Team, Final);

    designer

    The designer of the round (example: Joseph Juson)

    thumbnail

    The thumbnail of the round (preview: )

    backgroundImage

    The background image of the round

    socialShareImage

    The social share image of the round (preview: )

    blurredBackground

    The blurred background image of the round (preview: )

    Seasonpass

    season

    The season of the season pass (example: 1)

    items

    All the items of the season pass

    colors

    All the colors of the season pass

    patterns

    All the patterns of the season pass

    skins

    All the skins of the season pass

    faces

    All the faces of the season pass

    currencys

    All the currencys of the season pass

    celebrations

    All the celebrations of the season pass

    emotes

    All the emotes of the season pass

    nicknames

    All the nicknames of the season pass

    nameplates

    All the nameplates of the season pass

    Examples

    const fallguys = require("fallguys-api-fixed");
     
    let achievements = await fallguys.getAchievements();
    achievements.getAchievement("ACH_FALL_THROTTLE");
     
    let articles = await fallguys.getArticles();
    articles.getArticle(0);
     
    let colors = await fallguys.getColors();
    colors.getColor("Bubblegum");
    colors.getLegendaryColor("Bumblebee");
    colors.getEpicColor("Steel");
    colors.getRareColor("Raspberry");
    colors.getUncommonColor("Bubblegum");
    colors.getCommonColor("Beach Ball");
     
    let daily = await fallguys.getDaily();
    daily.pcStore[0];
    daily.ps4Store[0];
    daily.getFirstPCItem();
    daily.getSecondPCItem();
    daily.getThirdPCItem();
    daily.getFirstPS4Item();
    daily.getSecondPS4Item();
    daily.getThirdPS4Item();
     
    let rounds = await fallguys.getRounds();
    rounds.getRound(0);
    rounds.getRound("Dizzy Heights");

    Install

    npm i fall-guys-api-fixed

    DownloadsWeekly Downloads

    2

    Version

    1.0.1

    License

    ISC

    Unpacked Size

    46.1 kB

    Total Files

    17

    Last publish

    Collaborators

    • still_friends