scpper2.js v4.2.0

What the fuck is this ?

The SCP Foundation is a fictional organization that is the subject of a web-based collaborative writing project of the same name. The stories generated by the project describe the exploits of the Foundation, supposedly responsible for containing individuals, entities, locations, and objects that violate natural law (referred to as SCPs).

This module has been built to communicate and retrieve information from the Scpper project, which is the centralization of data and page's statistics From all branches of the Foundation.

Documentation

Create an instance of Scpper

You create an instance of Scpper by calling new Scpper() and passing in a configuration object

const api = new Scpper({ site: 'en' })

You must pass a valid abbreviation to "site" otherwise, an exception will be throw. Scpper class also accepts as property limit, which defines how many items the API should return for queries, and baseUrl if you want to use your own Scpper installation.

The Scpper class also accepts as second parameter an Axios configuration object(optional).

Calling the Scpper API

You can call different API methods of Scpper class like this:

api.getPage('1956234')
api.getUser('966960')

Click here to see the full API documentation.

List of available sites (API names in quotes) from ScpperDB:

• SCP Foundation: "en"
• Russian branch: "ru"
• Korean branch: "ko"
• Japanese branch: "ja"
• French branch: "fr"
• Spanish branch: "es"
• Thai branch: "th"
• Polish branch: "pl"
• German branch: "de"
• Chinese branch: "cn"
• Italian branch: "it"
• Traditional Chinese branch: "zh"
• Vietnamese branch: "vn"
• International Archive: "int"

SCP Foundation and all related works were created by SCP creative community and are available under CC BY-SA 3.0 license.

Thanks

Thanks to HelloEdit, who has created the Scpper.js that I've modified based off of.