https://github.com/wfcd/warframe-status
:cloud: Simple express app that parses worldState.php
https://github.com/wfcd/warframe-status
api api-server
Last synced: 27 days ago
JSON representation
:cloud: Simple express app that parses worldState.php
- Host: GitHub
- URL: https://github.com/wfcd/warframe-status
- Owner: WFCD
- License: mit
- Created: 2017-02-07T22:05:47.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2025-04-01T00:52:03.000Z (12 months ago)
- Last Synced: 2025-04-02T07:11:16.157Z (12 months ago)
- Topics: api, api-server
- Language: JavaScript
- Homepage: https://docs.warframestat.us
- Size: 6.75 MB
- Stars: 44
- Watchers: 7
- Forks: 12
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# warframe-status
Simple express app that parses worldState.php
[](https://github.com/WFCD/banner/blob/master/PROJECTS.md)
[](https://discord.gg/jGZxH9f)
[](https://github.com/semantic-release/semantic-release)
[](https://coveralls.io/github/WFCD/warframe-status?branch=main)
[](https://github.com/WFCD/warframe-status/actions/workflows/release.yml)
[](https://github.com/WFCD/warframe-status/actions/workflows/ci.yaml)
[](https://api.warframestat.us/pc/?language=en)
[](https://api.warframestat.us/ps4/?language=en)
[](https://api.warframestat.us/xb1/?language=en)
[](https://api.warframestat.us/swi/?language=en)
## Access
### REST-ish:
- `http://$host:$port/$platform`
- `http://$host:$port/$platform/$child-item`
- `http://$host:$port/$a-bunch-of-static-data`
### Sockets:
`ws://$host:$port/socket`
(or for the secure socket)
`wss://$host:$port/socket`
Requests taken as json strings in the socket packet.
Consumers will need to parse responses and stringify requests yourself, as ws doesn't provide a way to automatically parse them.
```json
{ "event": "ws:req", "packet": { "platform": "$platform", "language": "$language" } }
```
```json
{ "event": "twitter" }
```
```json
{ "event": "rss" }
```
connecting automatically subscribes the connection to events structured as:
```json5
{
event: 'twitter',
packet: '[]', // tweets
}
```
```json5
{
event: 'ws:update',
packet: '{}', // entire updated worldstate
}
```
```json5
{
event: '', // worldstate key,
packet: '', // worldstate key data
}
```
probably several others that can take some experimenting
## ENV Variables
| Key | Meaning |
| :---------------------- | :------------------------------------------------- |
| `TWITTER_KEY` | Twitter Account Key |
| `TWITTER_SECRET` | Twitter Account Secret |
| `TWITTER_BEARER_TOKEN` | Twitter OAuth Bearer Token |
| `WFINFO_FILTERED_ITEMS` | WF Info filtered items source json url |
| `WFINFO_PRICES` | WF Info prices source json url |
| `DISABLE_PRICECHECKS` | Disable pricecheck services |
| `SENTRY_DSN` | Sentry DNS for reporting errors |
| `BUILD` | Whether or not to forcibly build caches on startup |
| `LOG_LEVEL` | Logging level for logging |
| `HOST`/`HOSTNAME` | host or hostname for hosting service |
| `PORT`/`IP` | Port or IP address for hosting service |
It's highly recommended to use the local loopback (127.0.0.1) for HOST/HOSTNAME