Quickstart
Sell Cargo
After a few extractions, your cargo hold will likely be filled with ores and minerals that you may not need for your contract. You can sell your cargo at the nearby marketplace to unload those goods and earn some credits.
View market data
To view the types of goods available at the market, you can send the following request. Each market has a list of imports, exports and exchange goods which can be purchased and sold at the location.
curl 'https://api.spacetraders.io/v2/systems/:systemSymbol/waypoints/:asteroidWaypointSymbol/market' \
--header 'Authorization: Bearer INSERT_TOKEN_HERE'
Since your ship is present at the location, you can see the purchase and sell prices for each good.
You can also see the estimated trade volume for each good, which is rough estimate of price stability. Larger trade volumes indicate more stable prices, while smaller trade volumes indicate more volatile prices.
List ship cargo
You can view the cargo in your ship by sending a GET request to the my/ships/:shipSymbol
endpoint. You will want to sell the ores and minerals in your cargo hold that don't match the contract requirements.
curl 'https://api.spacetraders.io/v2/my/ships/:miningShipSymbol/cargo' \
--header 'Authorization: Bearer INSERT_TOKEN_HERE'
Sell goods
Before you can sell your cargo at the market, you will first need to dock your ship. You can dock your ship by sending a POST request to the my/ships/:shipSymbol/dock
endpoint.
curl --request POST \
--url 'https://api.spacetraders.io/v2/my/ships/:miningShipSymbol/dock' \
--header 'Authorization: Bearer INSERT_TOKEN_HERE'
You can sell your cargo at a marketplace by sending a POST request to the my/ships/:shipSymbol/sell
endpoint. You will need to specify the type of good you want to sell, along with the number of units.
curl --request POST \
--url 'https://api.spacetraders.io/v2/my/ships/:miningShipSymbol/sell' \
--header 'Authorization: Bearer INSERT_TOKEN_HERE' \
--header 'Content-Type: application/json' \
--data '{
"symbol": "IRON_ORE",
"units": "100"
}'
The response will include details about your agent, ship cargo, and the transaction. You can see the total price for the transaction in the totalPrice
field.