Skip to content
This repository has been archived by the owner on Mar 24, 2024. It is now read-only.

Latest commit

 

History

History
71 lines (39 loc) · 1.94 KB

FactionsApi.md

File metadata and controls

71 lines (39 loc) · 1.94 KB

\FactionsApi

All URIs are relative to https://api.spacetraders.io/v2

Method HTTP request Description
get_faction GET /factions/{factionSymbol} Get Faction
get_factions GET /factions List Factions

get_faction

crate::models::GetFaction200Response get_faction(faction_symbol) Get Faction

View the details of a faction.

Parameters

Name Type Description Required Notes
faction_symbol String The faction symbol [required]

Return type

crate::models::GetFaction200Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_factions

crate::models::GetFactions200Response get_factions(page, limit) List Factions

Return a paginated list of all the factions in the game.

Parameters

Name Type Description Required Notes
page Option<i32> What entry offset to request [default to 1]
limit Option<i32> How many entries to return per page [default to 10]

Return type

crate::models::GetFactions200Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]