NAV Navbar
  • Introduction
  • Queries
  • Items
  • Equipment
  • Market
  • Recipes
  • Characters
  • Dungeons
  • Legacy Endpoints
  • Introduction

    Valid for 3.x.x

    Welcome to the Unoffical BnS API! You can use my API which can get information on items, characters and marketplace info.

    Headers are on the left, more detailed info on the endpoints in the center and the outputs on the right.

    This example API documentation page was created with Slate.

    Queries

    Local Queries Information

    Almost all of the endpoints are queryable based on the content they contain, so if you want to see equipment that is only soul's then https://api.silveress.ie/bns/v3/equipment?type=soul has you covered.

    Global Queries

    Limit

    This changes the total responses you get from any endpoint and can be used to increase or decrease the amount returned.

    ?limit=n

    Skip

    This often works in conjunction with limit, it skips the first n responses.

    ?skip=n

    Beautify

    This is flag to change the JSON from human readable to a more compact version that works better with computers, 20%-50% space saving compared to normal.

    ?beautify=min
    ?beautify=human - Default

    Combined Example

    the below will return the compact JSON of 100 items and skipping the first 1000

    ?beautify=min&skip=1000&?limit=100

    Items

    Marketable Items

    [
      {
        "id": 821515,
        "name": "Premium Transformation Stone",
        "img": "http://static.ncsoft.com/bns_resource/ui_resource/grocery/grocery_element_steel3_4_1.png",
        "rank": 4,
        "stats": "",
        "updated": "2017-12-02T22:00:03.870Z",
        "itemTaxRate": 0.2,
        "merchantValue": 1,
        "characterLevel": 1
      },
      {
        "id": 810603,
        "name": "Soulstone",
        "img": "http://static.ncsoft.com/bns_resource/ui_resource/grocery/gather_shiny_gemstone_4_1.png",
        "rank": 4,
        "stats": "",
        "updated": "2017-12-02T22:00:03.870Z",
        "itemTaxRate": 0.1,
        "merchantValue": 1,
        "characterLevel": 1
      }
    ]
    

    https://api.silveress.ie/bns/v3/items

    Returns basic info on all marketable items.
    Info here is obtained from my once hourly scraping of the marketplace on both EU and NA.

    It is possible to see the same name twice as it can have a different ID ingame, eg "5 Soulstone Bundle" and "5-Soulstone Bundle"

    New

    Marketable items but ordered by newest first.

    Count

    [
      {
        "ISO": "2017-12-02T22:05:20.395Z",
        "equipmentCount": 742,
        "itemCount": 2614
      },
      {
        "ISO": "2017-12-02T21:05:24.664Z",
        "equipmentCount": 742,
        "itemCount": 2614
      }
    ]
    

    https://api.silveress.ie/bns/v3/items/count

    Returns the quantity of marketable items.

    ID

    [
      {
        "id": 821515,
        "name": "Premium Transformation Stone",
        "img": "http://static.ncsoft.com/bns_resource/ui_resource/grocery/grocery_element_steel3_4_1.png",
        "category": "69",
        "rank": 4,
        "stats": "",
        "updated": "2017-12-02T23:00:04.221Z",
        "guideUnitPrice": 3280000,
        "itemTaxRate": 0.2,
        "merchantValue": 1,
        "characterLevel": 1
      }
    ]
    

    https://api.silveress.ie/bns/v3/items/821515

    Gets info specific to that ID.

    I have somewhat abandoned this but it still outputs more info that the regular page.

    Equipment

    Base

    [
      {
        "name": "Acrimor Earring - Stage 10",
        "img": "http://static.ncsoft.com/bns_resource/ui_resource/accessory/acc_earring_baekchung_5-4phase_5_10_1.png",
        "rank": "5",
        "firstAdded": "2017-11-30T01:05:40.040Z"
      },
      {
        "name": "Acrimor Necklace",
        "img": "http://static.ncsoft.com/bns_resource/ui_resource/accessory/acc_necklace_gunwon_1-1phase_5_1.png",
        "rank": "5",
        "firstAdded": "2017-11-30T13:03:08.531Z"
      },
      {
        "name": "After Midnight",
        "img": "http://static.ncsoft.com/bns_resource/ui_resource/costume/costume_60039_jinm_col2_5_1.png",
        "rank": "5",
        "firstAdded": "2017-11-30T13:02:40.751Z"
      }
    ]
    

    https://api.silveress.ie/bns/v3/equipment

    Returns basic info on equipable.
    This is obtained from whenever anyone uses my character endpoint, the info is scraped from the loaded page.
    Queryable

    New

    https://api.silveress.ie/bns/v3/equipment/new
    Endpoint where Newest items are first.
    Queryable.

    Old

    https://api.silveress.ie/bns/v3/equipment/old
    Endpoint where oldest items are first. Made for use with a spreadsheet so new rows are added at the bottom.
    Queryable.

    New

    Marketable items but ordered by newest first.

    Count

    [
      {
        "ISO": "2017-12-02T22:05:20.395Z",
        "equipmentCount": 742,
        "itemCount": 2614
      },
      {
        "ISO": "2017-12-02T21:05:24.664Z",
        "equipmentCount": 742,
        "itemCount": 2614
      }
    ]
    

    https://api.silveress.ie/bns/v3/equipment/count

    Returns the quantity of equipable items and their type

    Market

    Available ID's

    [
      2280028,
      2280130,
      910110,
      2021415,
      2603373,
      2021411,
      910127,
      910128,
      2280151
    ]
    

    Returns a list of all ID's available under this method

    http://api.silveress.ie/bns/v3/market/<eu|na>/<current|history>

    Example
    http://api.silveress.ie/bns/v3/market/eu/current

    Info based on ID

    [
      {
        "name": "Premium Transformation Stone",
        "id": 821515,
        "ISO": "2017-12-02T23:00:04.219Z",
        "listings": [
          {
            "price": 3340000,
            "count": 1,
            "each": 3340000
          },
          {
            "price": 3350000,
            "count": 1,
            "each": 3350000
          },
            ...
        ],
        "totalListings": 19,
        "totalListed": 19
      }
    ]
    

    Returns price info based on that ID.
    If timeframe is current it only returns the most recent set of listings.
    If timeframe is history it returns the last month of listings on an hourly interval.

    http://api.silveress.ie/bns/v3/market/<eu|na>/<current|history>/<ID>

    Example
    http://api.silveress.ie/bns/v3/market/eu/current/821515


    If the timeframe is history a daterange can be queried.
    Example
    https://api.silveress.ie/bns/v3/market/eu/history/2280028?start=2017-12-01&end=2017-12-13

    Warning this isnt fully supported yet, its an early implimentation that somewhat works, I will be returning again to improve it.
    The dates are in yyyy-mm-dd format (ISO 8601)

    Current Modifiers

    /current/all

    Returns all teh current listings on the marketplace from the last scrape

    /current/lastListing

    Returns the last listing of all items listed on teh marketplace.
    So if an item is not currently listed on /current/all it will still be here.

    /current/lowest

    Flat array designed to be easier to import into google sheets via the importJSON script.

    /current/top/price

    Same as /current/all but ordered so most expensive listing is first.

    /current/top/quantity

    Same as /current/all but ordered so listing with the most items is first.

    /current/top/listings

    Same as /current/all but ordered so listing with teh most listings is first.

    Recipes

    All

    [
      {
        "id": 1,
        "active": "FALSE",
        "updated": "2017-09-13T14:55:51Z",
        "createdBy": "Acquired Taste",
        "type": "Food",
        "item": "Dumpling",
        "output": 2,
        "cost": 6,
        "guildRank": 1,
        "hours": 0.5,
        "xp": 24,
        "ingredients": [
          {
            "name": "Whole Chicken",
            "quantity": 10
          }
        ]
      },
      {
        "id": 417,
        "active": "TRUE",
        "updated": "2017-08-14T18:58:24Z",
        "createdBy": "process",
        "type": "material",
        "item": "Soulstone Crystal",
        "output": 1,
        "cost": 0,
        "ingredients": [
          {
            "name": "Soulstone",
            "quantity": 1
          }
        ]
      }
    ]
    

    Returns a list of all the recipes recorded.

    Example
    https://api.silveress.ie/bns/v3/recipe/all

    Current

    [
     {
        "id": 417,
        "active": "TRUE",
        "updated": "2017-08-14T18:58:24Z",
        "createdBy": "process",
        "type": "material",
        "item": "Soulstone Crystal",
        "output": 1,
        "cost": 0,
        "ingredients": [
          {
            "name": "Soulstone",
            "quantity": 1
          }
        ]
      },
      {
        "id": 418,
        "active": "TRUE",
        "updated": "2017-08-14T18:58:24Z",
        "createdBy": "process",
        "type": "material",
        "item": "Sacred Crystal",
        "output": 1,
        "cost": 0,
        "ingredients": [
          {
            "name": "Sacred Orb",
            "quantity": 1
          }
        ]
      }
    ]
    

    Returns a list of all the active recipes recorded.

    Example
    https://api.silveress.ie/bns/v3/recipe/current

    History

    [
      {
        "id": 1,
        "active": "FALSE",
        "updated": "2017-09-13T14:55:51Z",
        "createdBy": "Acquired Taste",
        "type": "Food",
        "item": "Dumpling",
        "output": 2,
        "cost": 6,
        "guildRank": 1,
        "hours": 0.5,
        "xp": 24,
        "ingredients": [
          {
            "name": "Whole Chicken",
            "quantity": 10
          }
        ]
      },
      {
        "id": 2,
        "active": "FALSE",
        "updated": "2017-09-13T14:55:51Z",
        "createdBy": "Acquired Taste",
        "type": "Food",
        "item": "Dumpling",
        "output": 5,
        "cost": 63,
        "guildRank": 2,
        "hours": 0.67,
        "xp": 33,
        "ingredients": [
          {
            "name": "Iron Ox Meat",
            "quantity": 20
          }
        ]
      }
    ]
    

    Returns a list of all the inactive recipes recorded.

    Example
    https://api.silveress.ie/bns/v3/recipe/history

    [
      {
        "id": 736,
        "active": "TRUE",
        "updated": "2017-08-15T12:09:37Z",
        "createdBy": "upgrade",
        "type": "weapon",
        "item": "Baleful Stage 9",
        "output": 1,
        "cost": 100000,
        "ingredients": [
          {
            "name": "Seraph Stage 9",
            "quantity": 1
          },
          {
            "name": "Pristine Oil",
            "quantity": 1
          }
        ]
      }
    ]
    

    Returns a list of recipes that match the criteria.

    Example
    https://api.silveress.ie/bns/v3/recipe/search?item=Baleful Stage 9&active=true
    https://api.silveress.ie/bns/v3/recipe/search?item=Baleful%20Stage%209&active=true

    Characters

    An endpoint to return information on either an individual character or character rankings.

    Character Info

    {
      "ap": 814,
      "hp": 69406,
      "piercing": 737,
    
      "...":"...",
    
      "accountName": "Silveress",
      "characterName": "Silveress Golden",
      "playerClass": "Blade Dancer",
      "playerLevel": 50,
      "playerLevelHM": 10,
      "server": "Jinsoyun",
      "faction": "Crimson Legion",
      "factionRank": "Aspirant",
      "guild": "Animals",
      "characterImg": "http://eu-gamepic.ncsoft.com/images/0201/45/zXlKAAAAAAA=.jpg"
    }
    

    Full

    Returns info on the character which can be pulled into google sheets by a template page I created.
    This endpoint also feeds my equipment endpoint.

    Example
    https://api.silveress.ie/bns/v3/character/full/<eu|na>/<Character Name>
    https://api.silveress.ie/bns/v3/character/full/eu/Silveress Golden
    https://api.silveress.ie/bns/v3/character/full/eu/Silveress%20Golden

    Ranking

    This is the same as the above, but with one key difference. In return for providing the stats you agree that I can:

    1. Display it in the ranking list.
    2. Can update the character info on a fixed schedule.

    More on this below.

    Example
    https://api.silveress.ie/bns/v3/character/ranking/<eu|na>/<Character Name>
    https://api.silveress.ie/bns/v3/character/ranking/eu/Silveress Golden

    Ranking - endpoint

    Returns list of all characters that were entered to the ranking and is sorted by the attribute chosen.
    The attributes are the names on the left hand side of the list.
    It is also queryable.
    All the characters on the list are updated daily at 00:00 UTC

    Example
    https://api.silveress.ie/bns/v3/character/rankings/<attribute>
    https://api.silveress.ie/bns/v3/character/rankings/ap
    https://api.silveress.ie/bns/v3/character/rankings/ap?region=eu
    https://api.silveress.ie/bns/v3/character/rankings/ap?region=eu&server=Jinsoyun
    https://api.silveress.ie/bns/v3/character/rankings/ap?region=eu&server=Jinsoyun&faction=Crimson Legion

    Disclaimer

    In return for providing the stats you agree that I can:

    1. Display it in the ranking list.
    2. Can update the character info on a fixed schedule.

    Account Removal

    If you want your character removed from the rankings list please contact me and it will be removed.

    Dungeons

    QuestBase

    [
      {
        "id": 1,
        "location": "Skybreak Spire",
        "quest": "Raven's Cry",
        "gold": 198000,
        "pve_or_pvp": "PvE",
        "reset_time": "Weekly",
        "party": 12,
        "xp": 60960
      },
      {
        "id": 2,
        "location": "Skybreak Spire",
        "quest": "Military Intervention",
        "gold": 181500,
        "pve_or_pvp": "PvE",
        "reset_time": "Weekly",
        "party": 12,
        "xp": 55770
      }
    ]
    

    A flat array of information about dungeon quests.
    Queryable.

    Example
    https://api.silveress.ie/bns/v3/dungeons/questsbase

    Daily Challenge

    [
     {
        "startDate": "2017-12-29T00:00:00.000Z",
        "Monday": [
          "Zakhan's Blade",
          "The Bonds that Bind Us",
          "In the Dead of Winter",
          "Frozen Phantasm",
          "One Win in the Beluga Lagoon",
          "Tag Match Win"
        ],
        "Tuesday": [
          "Roar of the Furnace",
          "Asura's Return",
          "Nightmare at the Necropolis",
          "Rose from the Past",
          "One Whirlwind Victory",
          "One on One"
        ],
        "Wednesday": [
          "..."
        ],
        "Thursday": [
          "..."
        ],
        "Friday": [
          "..."
        ],
        "Saturday": [
          "..."
        ],
        "Sunday": [
          "..."
        ],
        "Weekly": [
          "..."
        ]
      }
    ]
    

    An ordered list with the current daily challenge on top, contains days and quests for that day.
    Queryable.

    Example
    https://api.silveress.ie/bns/v3/dungeons/daily

    Merged Quests + Daily

    [
      {
        "id": 3,
        "location": "Skybreak Spire",
        "quest": "Dark Revival",
        "gold": 165000,
        "pve_or_pvp": "PvE",
        "reset_time": "Weekly",
        "party": 12,
        "xp": 50770,
        "daily_challenge": [],
        "weekly_challenge": true
      },
      {
        "id": 7,
        "location": "Sogun's Lament",
        "quest": "Asura's Return",
        "gold": 38300,
        "pve_or_pvp": "PvE",
        "reset_time": "Daily",
        "party": 6,
        "xp": 17300,
        "daily_challenge": [
          "Tuesday",
          "Sunday"
        ],
        "weekly_challenge": false
      }
    ]
    

    Same as QuestBase but also contains the Daily Challenge info within it.
    Queryable.

    Example
    https://api.silveress.ie/bns/v3/dungeons/quests
    https://api.silveress.ie/bns/v3/dungeons/quests?weekly_challenge=true
    https://api.silveress.ie/bns/v3/dungeons/quests?daily_challenge=Monday,Tuesday

    Legacy Endpoints

    v2

    [
       {
        "Name": "5 Soulstone Bundle",
        "ID": 2280028
      },
      {
        "Name": "Acquired Taste Secret Technique - Cinderlands",
        "ID": 811039
      }
    ]
    

    v3 emulates the older endpoints from v2

    The below returns a list of IDs and Names.

    Example
    http://api.silveress.ie/bns/v2/market

    Current

    [
        {
        "ISO": "2017-12-03T11:00:03.564Z",
        "ID": 2280028,
        "ItemPrice": 30000,
        "Quantity": 3
      },
      {
        "ISO": "2017-12-03T11:00:03.564Z",
        "ID": 2021120,
        "ItemPrice": 4200,
        "Quantity": 1
      }
    ]
    

    Returns a flat array with little info

    Example
    http://api.silveress.ie/bns/v2/market/current/<eu|na>
    http://api.silveress.ie/bns/v2/market/current/eu

    History

    [
         {
        "ID": 2280028,
        "timeDate": "2017-08-27T22:00:03.169Z",
        "minPrice": 45000,
        "avgPrice": 41193,
        "maxPrice": 35000,
        "totalItems": 15,
        "totalListings": 15
      },
      {
        "ID": 2280028,
        "timeDate": "2017-08-27T23:00:03.107Z",
        "minPrice": 40000,
        "avgPrice": 40764,
        "maxPrice": 39000,
        "totalItems": 14,
        "totalListings": 14
      }
    ]
    

    Returns a flat array with basic info on an item over a period of time

    Example
    http://api.silveress.ie/bns/v2/market/history/<eu|na>/<ID>
    https://api.silveress.ie/bns/v2/market/history/eu/2280028

    v1

    CSV

    
    "Name","ID","Quantity","ItemPrice","LastUpdate"
    "5 Soulstone Bundle",2280028,3,30000,"2017-12-03T13:00:03.141Z"
    "Air Assassin Design",2280130,1,990000,"2017-12-03T04:00:03.207Z"
    "Apron of Vanity",910128,1,2300,"2017-12-03T13:00:03.141Z"
    
    

    v1 was offline for quite a while as figuring out how to emulate it in v3 was quite a challenge.

    It outputs data in the format of csv and can be used as a query in Excel or importData in Google Sheets.

    Example:
    http://api.silveress.ie/bns/market/current/<eu|na>
    http://api.silveress.ie/bns/market/current/eu