Skip to content

A client for the Star Wars Combine Web Services 2.0 API that supports both javascript and typescript

Notifications You must be signed in to change notification settings

kaelonR/swcombine-js-sdk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Star Wars Combine Web Services 2.0 JS/TS SDK

Typescript and Javascript SDK for the Star Wars Combine 2.0 Web Services. The SDK is currently a WIP. Status is as follows:

API SDK Status

  • ❌ = Not yet implemented
  • 🚧 = Partially implemented
  • ✔️ = Implemented
  • ✅ = Implemented and covered by tests
Endpoint Status Availability OAuth scope required (if applicable)

OAuth

Public
Get token using server flow (node.js only) Public
Get token using client flow (browser only) Public
Get granted permissions OAuth 🔒

Permissions

List permissions ✔️ Public

Rate Limits

List rate limits Public

Time

Get current SWC time Public/on device
Convert between SWC and Unix time Public/on device
Convert between SWC time and Date objects Public/on device

Character

Get character info OAuth 🔒 character_read
Get character's credits OAuth 🔒 character_credits
Get character's creditlog OAuth 🔒 character_credits
Get UID by handle(handlecheck) Public
List received messages OAuth 🔒 messages_read
List sent messages OAuth 🔒 messages_read
Send message from character OAuth 🔒 messages_send
Get message by id OAUth 🔒 messages_read
Delete message by id OAuth 🔒 messages_delete
Get character's skills OAuth 🔒 character_skills
List character's privileges OAuth 🔒 character_privileges
Check if character has privilege OAuth 🔒 character_privileges, and must be logged in as someone that can view the privileges of others.
Grant privilege to a character OAuth 🔒 character_privileges, and must be logged in as someone that has the ability to grant privileges to others.
Revoke privilege from character OAuth 🔒 character_privileges, and must be logged in as someone that can grant/revoke privileges of others.

Datacard

List datacards OAuth 🔒 faction_datacards_read
Get datacard OAuth 🔒 faction_datacards_read
Assign datacard OAuth 🔒 faction_datacards_write
Delete datacard assignment OAuth 🔒 faction_datacards_write

Events

List events for character OAuth 🔒 character_events
Get event by uid OAuth 🔒 character_events

Factions

List factions Public
Get faction by uid Public
Get faction credits OAuth 🔒 faction_credits_read
Get faction's creditlog OAuth 🔒 faction_credits_read
Send faction credits OAuth 🔒 faction_credits_write
List faction's budgets OAuth 🔒 faction_budgets_read
Get faction budget by uid OAuth 🔒 faction_budgets_read
List faction members OAuth 🔒 faction_members
Update faction member's infofields OAuth 🔒 faction_members, and must be logged in as someone that can update infofields
List faction's stock holders OAuth 🔒 faction_stocks

Galaxy

List sectors Public
Get sector by uid Public
List systems Public
Get system by uid Public
List planets Public
Get planet by uid Public
List stations Public
Get station by uid Public
List cities Public
Get city by uid Public

Inventory

List inventories OAuth 🔒 [personal/faction]_inv_overview
List entities in inventory OAuth 🔒 [personal/faction]_inv_[inventory]_read
Get one entity in inventory OAuth 🔒 [personal/faction]_inv_[inventory]_read
Modify entity info OAuth 🔒 [personal/faction]_inv_[inventory]_assign
Rename entity OAuth 🔒 [personal/faction]_inv_[inventory]_rename
Makeover entity OAuth 🔒 [personal/faction]_inv_[inventory]_makeover
Apply tag to entity OAuth 🔒 [personal/faction]_inv_[inventory]_tags_write
Remove tag from entity OAuth 🔒 [personal/faction]_inv_[inventory]_tags_write
Clear all tags from entity OAuth 🔒 [personal/faction]_inv_[inventory]_tags_write

Location

Get location for specified entity OAuth 🔒 character_location

Market

List all public market vendors Public
Get vendor info Public

News

List GNS news Public
Get one GNS Item Public
List Sim news Public
Get one Sim news item Public

Types

List classes of type Public
List entities of type Public
List entities by class and type Public
Get type for existing entity Public
List all entity types Public

About

A client for the Star Wars Combine Web Services 2.0 API that supports both javascript and typescript

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published