README.md

SCP Foundation Unofficial API

To be used with data from the SCP Foundation WebScraper also by me.

Get Started

Clone this repo and cd to the cloned directory. Then run:

npm i
node server.js

Endpoints

Only available (currently) is the GET method to the /scp/:id endpoint. id is an integer. 0-9 starts with '00', 10-99 starts wtih '0'

Database Schema:

"100": {
    "id": "SCP-100",
    "class": "...",
    "containment": "...",
    "description": "...",
    "more_info": {},
}, 
"101": {
    "id": "SCP-101",
    "class": "...",
    "containment": "...",
    "description": "...",
    "more_info": {},
},

Return Schema:

(from the repo mentioned above)

{
    "id": "str",
    "class": "str",
    "containment": "str",
    "description": "str",
    "more_info": "json"
}

e.g.

{
    "id": "SCP-343",
    "class": "Safe",
    "containment": "SCP-343 resides in a 6.1m by 6.1m (20 ft by..."
    "description": "CP-343 is a male, seemingly race-less, humanoid in...",
    "more_info": {
        "Addendum #343-1": "SCP-343, colloquially nicknamed...."
    }
}