Giters

SpaceTradersAPI / issues-and-suggestions

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Suggestion: Add any supported query parameters to the API docs

nhowell opened this issue · comments

commented

In the "How To Play Guide", there are two examples of endpoints that support filtering the results, but the API docs do not mention these query parameters:

  • The ability to filter available ships by class: https GET api.spacetraders.io/game/ships token==$token class==MK-I
  • The ability to filter locations by type: https GET api.spacetraders.io/game/systems/OE/locations token==$token type==PLANET

I suggest that the API docs be updated to include any supported query parameters on all of the endpoints.