Fleet

Extract Resources

Changed on

Extract resources from a waypoint that can be extracted, such as asteroid fields, into your ship. Send an optional survey as the payload to target specific yields.

The ship must be in orbit to be able to extract and must have mining equipments installed that can extract goods, such as the Gas Siphon mount for gas-based goods or Mining Laser mount for ore-based goods.

The survey property is now deprecated. See the extract/survey endpoint for more details.

post/my/ships/{shipSymbol}/extract

Request

  • Base URL
    https://api.spacetraders.io/v2
  • URL
    https://api.spacetraders.io/v2/my/ships/{shipSymbol}/extract
  • Auth
    HTTP bearer

Path parameters

shipSymbolstring required

The ship symbol.

Request body

surveySurveyJson (unresolved $ref)

Response

Extracted successfully.

Changes

  • 197cf9b9a2b6Revision changes
    • info

      added the optional property / to the response with the status

  • bc6e0ed16121Revision changes
    • info

      removed from the // response property oneOf list for the response status