Location

This is the documentation for the /location endpoint. There are currently 9 locations sorted by id.

Location schema

Key	Type	Description
id	int	The id of the location (starting from 1).
name	string	The name of the location.
type	string	The type of the location.
inhabitants	array	Inhabitants of the location.
notable_residents	array	Notable residents(if any).
img_url	string (url)	Image of the location.

Get all locations

You can access the list of locations by using the /location endpoint.

https://finalspaceapi.com/api/v0/location/

[
  {
    "id": 1,
    "name": "Earth",
    "type": "Planet",
    "inhabitants": ["Humans", "Animals", "Robots", "Aliens"],
    "notable_residents": [
      "https://finalspaceapi.com/api/v0/character/1",
      "https://finalspaceapi.com/api/v0/character/3"
    ],
    "img_url": "https://finalspaceapi.com/api/location/image/earth.jpg"
  },
 ...
]

Get a single location

You can get a single location by adding the id as a parameter: /location/3

https://finalspaceapi.com/api/v0/location/3

{
  "id": 3,
  "name": "Tera Con Prime",
  "type": "Destroyed planet",
  "inhabitants": ["Lord Commander's army", "Infinity Guard soldiers"],
  "notable_residents": [
    "https://finalspaceapi.com/api/v0/character/10",
    "https://finalspaceapi.com/api/v0/character/11",
    "https://finalspaceapi.com/api/v0/character/20",
    "https://finalspaceapi.com/api/v0/character/27"
  ],
  "img_url": "https://finalspaceapi.com/api/location/image/tera_con_prime.jpg"
}

Sort the response

You can now sort the response based on id by passing the /?sort=asc or /?sort=desc query in the URL.

https://finalspaceapi.com/api/v0/location/?sort=desc

[
  {
    "id": 9,
    "name": "The Order of the Twelve",
    "type": "Temple",
    "inhabitants": [],
    "notable_residents": [],
    "img_url": "https://finalspaceapi.com/api/location/image/the_order_of_the_twelve.jpg"
  },
  ...
]

Limit the response

You can now limit the response by passing the /?limit={number} query in the URL.

https://finalspaceapi.com/api/v0/location/?limit=3

[
  {
    "id": 1,
    "name": "Earth",
    "type": "Planet",
    "inhabitants": ["Humans", "Animals", "Robots", "Aliens"],
    "notable_residents": [
      "https://finalspaceapi.com/api/v0/character/1",
      "https://finalspaceapi.com/api/v0/character/3"
    ],
    "img_url": "https://finalspaceapi.com/api/location/image/earth.jpg"
  },
  {
    "id": 2,
    "name": "Final Space",
    "type": "Dimension",
    "inhabitants": ["Titans", "Invictus", "Quinn"],
    "notable_residents": [
      "https://finalspaceapi.com/api/v0/character/2",
      "https://finalspaceapi.com/api/v0/character/3",
      "https://finalspaceapi.com/api/v0/character/15",
      "https://finalspaceapi.com/api/v0/character/18"
    ],
    "img_url": "https://finalspaceapi.com/api/location/image/final_space.jpg"
  },
  {
    "id": 3,
    "name": "Tera Con Prime",
    "type": "Destroyed planet",
    "inhabitants": ["Lord Commander's army", "Infinity Guard soldiers"],
    "notable_residents": [
      "https://finalspaceapi.com/api/v0/character/10",
      "https://finalspaceapi.com/api/v0/character/11",
      "https://finalspaceapi.com/api/v0/character/20",
      "https://finalspaceapi.com/api/v0/character/27"
    ],
    "img_url": "https://finalspaceapi.com/api/location/image/tera_con_prime.jpg"
  }
]

Use limit with sort

You can limit and sort the response simultaneously by passing both limit={number} and sort=desc query parameters in the URL and seperating them with & operator.

https://finalspaceapi.com/api/v0/location/?limit=3&sort=desc

[
  {
    "id": 9,
    "name": "The Order of the Twelve",
    "type": "Temple",
    "inhabitants": [],
    "notable_residents": [],
    "img_url": "https://finalspaceapi.com/api/location/image/the_order_of_the_twelve.jpg"
  },
  {
    "id": 8,
    "name": "Lazarus Trap",
    "type": "Trap",
    "inhabitants": [],
    "notable_residents": [],
    "img_url": "https://finalspaceapi.com/api/location/image/lazarus_trap.jpg"
  },
  {
    "id": 7,
    "name": "Deathcropolis",
    "type": "Gladiatorial Colosseum",
    "inhabitants": [],
    "notable_residents": [],
    "img_url": "https://finalspaceapi.com/api/location/image/deathcropolis.jpg"
  }
]