# serap

> A NodeJS Module for interacting with the Space Engineers Remote API

Latest version **1.6.0** (published 2020-11-05) · ISC license · 0 weekly downloads

## Install

```sh
npm install serap
pnpm add serap
yarn add serap
bun add serap
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.6.0 |
| Published | 2020-11-05 |
| First published | 2020-04-15 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | James Bacon |
| Maintainers | jamesbacon |

## Links

- npm: https://www.npmjs.com/package/serap
- Repository: https://github.com/JamesBacon/serapi
- Homepage: https://github.com/JamesBacon/serapi#readme
- Issues: https://github.com/JamesBacon/serapi/issues
- npm.io page: https://npm.io/package/serap

## Recent versions

- 1.6.0 (latest) — 2020-11-05
- 1.5.0 — 2020-11-05
- 1.0.0 — 2020-04-15

## README

# serap

A NodeJS Module for interacting with the Space Engineers Remote API.

## Installation
```bash
npm i serap
```
This Module uses built-in Node Modules. (http, crypto, Buffer)

## Usage
Require the Module and set up your options.
```javascript
const serap = require("serap");

const options = {
  ip: "127.0.0.1",
  port: 8080,
  secret: "Your Secret"
};

serap.credentials(options);
```
Now you can use all the endPoints like so:
```javascript
serap.server().then(res => {
  console.log(res)
});
```
A full list of Endpoints can be found below.

## Endpoints
All endPoints are GET only. Some do have POST, DELETE and PATCH available, but they have not been added to this Module yet.

`.players()` - `"/v1/session/players"`

`.asteroids()` - `"/v1/session/asteroids"`

`.grids()` - `"/v1/session/grids"`

`.floatingObjects()` - `"/v1/session/floatingObjects"`

`.planets()` - `"/v1/session/planets"`

`.chat()` - `"/v1/session/chat"`

`.server()` - `"/v1/server"`

`.ping()` - `"/v1/server/ping"`

`.bannedPlayers()` - `"/v1/admin/bannedPlayers"`

`.kickedPlayers()` - `"/v1/admin/kickedPlayers"`

---
_Source: https://npm.io/package/serap · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._