Sunshine is an unoffical API for The Overcast Network's website. This API is made by VesterRex and Jake_0. The API uses a technique called "web scraping" to retrive information on oc.tc such as stats, fourm posts and, tournament teams. The API then posts the data in a JSON format. It also has a thread and comment posting feature. Sunshine is written in node.js.
To retrive a specific page of something use the follow parameter:
For example this link will get me the 2nd page of the What's New forum category.
Stats,Forum Topics,Forum Categories,Teams,Punishments.
Some modules use ids to retrive information. The id in this case is a MongoDB hash. An id looks something like this.
By default the stats module will return top kills in the last 24 hours in all gamemodes.
Stats has three parameters time, game, and, sort.
This example retrives the top stats on wool captures for the past week in all gametypes.
All the properties for the three parameters are down below.
| Parameter | Properties |
| time | day, week, eternity |
| game | all, projectares, ghostsquadron |
| sort | kills, deaths, kd, kk, cores_leaked, wool_placed, destroyed_destroyables, playing_time |
To find a specific player's stats and information use the following format below.
For example, the code below will retrive the player information for the player
Specify a team's name to retrive their information.
Not specifing a team will retrive a list of all the teams.
The following link will retrive information for the team Drifters.
To obtain a list of all tournaments do not specify a tournament.
For example, this snippet will parse the tournament Attack of the Cores.
Remeber to use '-' instead of spaces when dealing with tournaments.
To get a specifc forum topic you are going to need the thread's id. Please refer to theid part of this Documentation.
For example, this will get you the topic
Specifying nothing except for what is below will return all* the categories of the forums and their ids.
Giving an id will give you the first page of the forum category specified.
This example will return the first page of the forum category Announcements.
Finally, using the keyword new will return the front page of the What's New category; the most recent posts.
To retrive a list of the most recent punishments use:
If you want to retrive a specific punsihment use its id.
