spacetraders/api-docs
1
0
Fork 0
mirror of https://github.com/SpaceTradersAPI/api-docs.git synced 2024-11-15 06:40:51 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1 from nhowell/fix-typos

Browse Source 
Fix typos in alpha.md
This commit is contained in:
SpaceAdmiral 2022-03-10 21:33:33 -08:00 committed by GitHub
commit 6fd183e98b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/alpha.md
View File

@ -65,7 +65,7 @@ The 2.0 version of the API has been significantly reworked and introduces some n
- **Trade** - all goods in the universe have a unique trade symbol (in all caps), such as `IRON_ORE`, `NANOBOTS` or `REACTOR_FISSION_I`. - **Trade** - all goods in the universe have a unique trade symbol (in all caps), such as `IRON_ORE`, `NANOBOTS` or `REACTOR_FISSION_I`.
- **Market** - most populated waypoints have a market where you can buy and sell goods. Each market will have a list of imports, exports and commodities that you can trade in. Markets evolve with player activity - prices will rise and fall with trades, and new imports or exports will be added as the market grows. - **Market** - most populated waypoints have a market where you can buy and sell goods. Each market will have a list of imports, exports and commodities that you can trade in. Markets evolve with player activity - prices will rise and fall with trades, and new imports or exports will be added as the market grows.
- **Tariff** - a flat tax added to each unit of a good traded at a market - **Tariff** - a flat tax added to each unit of a good traded at a market
- **Shipyards** - where agents can purchase ships, perform maintanence, or install new modules and mounts. - **Shipyards** - where agents can purchase ships, perform maintenance, or install new modules and mounts.
### New API Endpoints ### New API Endpoints
@ -77,7 +77,7 @@ All routes that are prefixed with `/my` will require an agent access token to be
When registering your account, you will be given a different type of token called an Account Token, which allows you to create a new Agent or update your account details such as email address, discord handle or patreon code. When registering your account, you will be given a different type of token called an Account Token, which allows you to create a new Agent or update your account details such as email address, discord handle or patreon code.
All routes targeting a specific ship, such as `/my/ships/COBRA-00AF/survey` will put a lock on your ship until the request is resolved. This means you can only take a single action at a time for your ship. Sending two simaltaneous actions for a single ship will throw a 409 conflict response code. All routes targeting a specific ship, such as `/my/ships/COBRA-00AF/survey` will put a lock on your ship until the request is resolved. This means you can only take a single action at a time for your ship. Sending two simultaneous actions for a single ship will throw a 409 conflict response code.
All routes with the prefix `/systems` will return limited data until an agent submits the chart for that system or you have a ship present in the system. All routes with the prefix `/systems` will return limited data until an agent submits the chart for that system or you have a ship present in the system.