# info.description
Boundless Lexicon API v2. Everything about the game Boundless.

Disclaimer: Boundlexx is an unoffical API for the game Boundless. There is no
affiliation with Wonderstruck Games.

The v2 API is designed for speed and efficently compared to
[v1](/api/v1/) which is designed for discoverability.
What this means is the `list` views for a lot of resources will return a
lot less data then their detail view. Generally `list` views only
return non-relational "essential" data. `retrieve` views will return all
of the data about that specific object.

Also, in many cases relational data has been stripped out. Now you only a
get a lookup key to that object and you need to call the other resource
endpoint for more data. The "general" idea is that the `list` of any of the
essential top level resources will be cached by the client to allow for rapid
look up.

# paths./blocks/.get.description
Retrieves the list of blocks with their item mapping

# paths./blocks/.get.parameters[].description
The initial index from which to return the results.

# paths./colors/.get.description
Retrieves the list of colors avaiable in Boundless

# paths./colors/.get.parameters[].description
The initial index from which to return the results.

# paths./colors/.get.parameters[].description
Filters the list of localized named returned.

# paths./colors/.get.parameters[].description
Which field to use when ordering the results.

# paths./colors/{game_id}/.get.parameters[].description
Filters the list of localized named returned.

# paths./colors/{game_id}/.get.parameters[].description
Which field to use when ordering the results.

# paths./colors/{game_id}/sovereign-blocks/.get.description
Gets current Possible Sovereign Blocks choices for given color

# paths./colors/{color__game_id}/blocks/.get.description
Retrieves the list of the items for a given color

# paths./colors/{color__game_id}/blocks/.get.parameters[].description
The initial index from which to return the results.

# paths./colors/{color__game_id}/blocks/.get.parameters[].description
Filter out Sovereign/non Sovereign worlds

# paths./colors/{color__game_id}/blocks/.get.parameters[].description
Include previous avaiable Sovereign colors

# paths./colors/{color__game_id}/blocks/.get.parameters[].description
Include inactive worlds (no longer in game API)

# paths./colors/{color__game_id}/blocks/.get.parameters[].description
Which field to use when ordering the results.

# paths./colors/{color__game_id}/blocks/{item__game_id}/.get.description
Retrieves the counts worlds for a given color/item combination

# paths./colors/{color__game_id}/blocks/{item__game_id}/.get.parameters[].description
Filter out Sovereign/non Sovereign worlds

# paths./colors/{color__game_id}/blocks/{item__game_id}/.get.parameters[].description
Include previous avaiable Sovereign colors

# paths./colors/{color__game_id}/blocks/{item__game_id}/.get.parameters[].description
Include inactive worlds (no longer in game API)

# paths./colors/{color__game_id}/blocks/{item__game_id}/.get.parameters[].description
Which field to use when ordering the results.

# paths./emojis/.get.description
Retrieves the list of emojis from the game Boundless.

# paths./emojis/.get.parameters[].description
The initial index from which to return the results.

# paths./emojis/.get.parameters[].description
Which field to use when ordering the results.

# paths./emojis/{name}/.get.description
Retrieves an emojis from the game Boundless.

# paths./emojis/{name}/.get.parameters[].description
Which field to use when ordering the results.

# paths./exports/.get.description
Retrieves the list of game files from the game Boundless.

Requires authentication. Provide `Authorization: Token <token>` header.

# paths./exports/.get.parameters[].description
The initial index from which to return the results.

# paths./items/.get.description
Retrieves the list of items avaiable in Boundless

# paths./items/.get.parameters[].description
The initial index from which to return the results.

# paths./items/.get.parameters[].description
Filters the list of localized named returned.

# paths./items/.get.parameters[].description
Filters out items with/without metal variants

# paths./items/.get.parameters[].description
Filters out items that vary from world to world with colors (rock, grass, wood, etc.)

# paths./items/.get.parameters[].description
Which field to use when ordering the results.

# paths./items/{game_id}/.get.description
Retrieves a items with a given ID.

If a `resource_counts_url` is provided, it means this item is
a "resource" in Boundless. `resource_counts_url` provide most
resource counts of the item on all Boundless worlds.

If `has_color` for an image is true and there is an `image_url`, you can
replace the file name from `{item.game_id}.png` to
`{item.game_id}_{color.game_id}.png` to get an image for a specific color.
The color for the default image is based on the `default_color` property.

`has_metal_variants` is the same thing, but for the 5 different types of
metals.

# paths./items/{game_id}/.get.parameters[].description
Filters the list of localized named returned.

# paths./items/{game_id}/.get.parameters[].description
Filters out items with/without metal variants

# paths./items/{game_id}/.get.parameters[].description
Filters out items that vary from world to world with colors (rock, grass, wood, etc.)

# paths./items/{game_id}/.get.parameters[].description
Which field to use when ordering the results.

# paths./items/{game_id}/request-baskets/.get.description
Gets current Request Baskets for given item

# paths./items/{game_id}/sovereign-colors/.get.description
Gets current Possible Sovereign Color choices for given item

# paths./items/{item__game_id}/resource-counts/.get.description
Retrieves the list of the counts of the resource by world.

This endpoint will only exist if the given item is a "resource"

# paths./items/{item__game_id}/resource-counts/.get.parameters[].description
The initial index from which to return the results.

# paths./items/{item__game_id}/resource-counts/.get.parameters[].description
Filter out Sovereign/non Sovereign worlds

# paths./items/{item__game_id}/resource-counts/.get.parameters[].description
Which field to use when ordering the results.

# paths./items/{item__game_id}/resource-counts/{world_id}/.get.description
Retrieves the counts of the resource on a given world.

# paths./items/{item__game_id}/resource-counts/{world_id}/.get.parameters[].description
Filter out Sovereign/non Sovereign worlds

# paths./items/{item__game_id}/resource-counts/{world_id}/.get.parameters[].description
Which field to use when ordering the results.

# paths./items/{item__game_id}/colors/.get.description
Retrieves the list of colors for a given item

# paths./items/{item__game_id}/colors/.get.parameters[].description
The initial index from which to return the results.

# paths./items/{item__game_id}/colors/.get.parameters[].description
Filter out Sovereign/non Sovereign worlds

# paths./items/{item__game_id}/colors/.get.parameters[].description
Include previous avaiable Sovereign colors

# paths./items/{item__game_id}/colors/.get.parameters[].description
Include inactive worlds (no longer in game API)

# paths./items/{item__game_id}/colors/.get.parameters[].description
Which field to use when ordering the results.

# paths./items/{item__game_id}/colors/{color__game_id}/.get.description
Retrieves the list worlds for specific color/item combination

# paths./items/{item__game_id}/colors/{color__game_id}/.get.parameters[].description
Filter out Sovereign/non Sovereign worlds

# paths./items/{item__game_id}/colors/{color__game_id}/.get.parameters[].description
Include previous avaiable Sovereign colors

# paths./items/{item__game_id}/colors/{color__game_id}/.get.parameters[].description
Include inactive worlds (no longer in game API)

# paths./items/{item__game_id}/colors/{color__game_id}/.get.parameters[].description
Which field to use when ordering the results.

# paths./metals/.get.description
Retrieves the list of metals avaiable in Boundless

# paths./metals/.get.parameters[].description
The initial index from which to return the results.

# paths./metals/.get.parameters[].description
Filters the list of localized named returned.

# paths./metals/.get.parameters[].description
Which field to use when ordering the results.

# paths./metals/{game_id}/.get.parameters[].description
Filters the list of localized named returned.

# paths./metals/{game_id}/.get.parameters[].description
Which field to use when ordering the results.

# paths./recipe-groups/.get.description
Retrieves the list of skill groups avaiable in Boundless

# paths./recipe-groups/.get.parameters[].description
The initial index from which to return the results.

# paths./recipe-groups/.get.parameters[].description
Filters the list of localized named returned.

# paths./recipe-groups/{id}/.get.parameters[].description
A unique integer value identifying this recipe group.

# paths./recipe-groups/{id}/.get.parameters[].description
Filters the list of localized named returned.

# paths./recipes/.get.description
Retrieves the list of recipes avaiable in Boundless

# paths./recipes/.get.parameters[].description
The initial index from which to return the results.

# paths./recipes/.get.parameters[].description
Filters the list of localized named returned.

# paths./recipes/{id}/.get.parameters[].description
A unique integer value identifying this recipe.

# paths./recipes/{id}/.get.parameters[].description
Filters the list of localized named returned.

# paths./skill-groups/.get.description
Retrieves the list of skill groups avaiable in Boundless

# paths./skill-groups/.get.parameters[].description
The initial index from which to return the results.

# paths./skill-groups/.get.parameters[].description
Filters the list of localized named returned.

# paths./skill-groups/.get.parameters[].description
Which field to use when ordering the results.

# paths./skill-groups/{id}/.get.parameters[].description
A unique integer value identifying this skill group.

# paths./skill-groups/{id}/.get.parameters[].description
Filters the list of localized named returned.

# paths./skill-groups/{id}/.get.parameters[].description
Which field to use when ordering the results.

# paths./skills/.get.description
Retrieves the list of skills avaiable in Boundless

# paths./skills/.get.parameters[].description
The initial index from which to return the results.

# paths./skills/.get.parameters[].description
Filters the list of localized named returned.

# paths./skills/.get.parameters[].description
Which field to use when ordering the results.

# paths./skills/{id}/.get.parameters[].description
A unique integer value identifying this skill.

# paths./skills/{id}/.get.parameters[].description
Filters the list of localized named returned.

# paths./skills/{id}/.get.parameters[].description
Which field to use when ordering the results.

# paths./worlds/.get.description
Retrieves the list of worlds avaiable in Boundless.

This endpoint is deprecated in favor of `/api/v1/worlds/simple/`.

The functionality of this endpoint will be replaced with that one in the
on 1 December 2020.

# paths./worlds/.get.parameters[].description
The initial index from which to return the results.

# paths./worlds/.get.parameters[].description
Filters start based on a given time contraint. `start_after` sets lower bound and `start_before` sets upper bound. Format is ISO 8601

# paths./worlds/.get.parameters[].description
Filters end based on a given time contraint. `end_after` sets lower bound and `end_before` sets upper bound. Format is ISO 8601

# paths./worlds/.get.parameters[].description
Filter out Sovereign/non Sovereign worlds

# paths./worlds/.get.parameters[].description
Include inactive worlds (no longer in game API)

# paths./worlds/.get.parameters[].description
Include previous colors for world (Sovereign only)

# paths./worlds/.get.parameters[].description
Filters last_updated based on a given time contraint. `last_updated_after` sets lower bound and `last_updated_before` sets upper bound. Format is ISO 8601

# paths./worlds/.get.parameters[].description
Which field to use when ordering the results.

# paths./worlds/{id}/.get.parameters[].description
A unique integer value identifying this world.

# paths./worlds/{id}/.get.parameters[].description
Filters start based on a given time contraint. `start_after` sets lower bound and `start_before` sets upper bound. Format is ISO 8601

# paths./worlds/{id}/.get.parameters[].description
Filters end based on a given time contraint. `end_after` sets lower bound and `end_before` sets upper bound. Format is ISO 8601

# paths./worlds/{id}/.get.parameters[].description
Filter out Sovereign/non Sovereign worlds

# paths./worlds/{id}/.get.parameters[].description
Include inactive worlds (no longer in game API)

# paths./worlds/{id}/.get.parameters[].description
Include previous colors for world (Sovereign only)

# paths./worlds/{id}/.get.parameters[].description
Filters last_updated based on a given time contraint. `last_updated_after` sets lower bound and `last_updated_before` sets upper bound. Format is ISO 8601

# paths./worlds/{id}/.get.parameters[].description
Which field to use when ordering the results.

# paths./worlds/{id}/beacons/.get.parameters[].description
A unique integer value identifying this world.

# paths./worlds/{id}/block-colors/.get.description
Retrieves the block colors for a given world

# paths./worlds/{id}/block-colors/.get.parameters[].description
A unique integer value identifying this world.

# paths./worlds/{id}/request-baskets/.get.description
Gets current Request Baskets for given world

# paths./worlds/{id}/request-baskets/.get.parameters[].description
A unique integer value identifying this world.

# paths./worlds/{id}/settlements/.get.description
Gets current Settlements for given world

# paths./worlds/{id}/settlements/.get.parameters[].description
A unique integer value identifying this world.

# paths./worlds/{id}/shop-stands/.get.description
Gets current Shop Stands for given world

# paths./worlds/{id}/shop-stands/.get.parameters[].description
A unique integer value identifying this world.

# paths./worlds/{world_source__id}/distances/.get.description
Retrieves the list of distances to know worlds

# paths./worlds/{world_source__id}/distances/.get.parameters[].description
The initial index from which to return the results.

# paths./worlds/{world_source__id}/distances/{world_id}/.get.description
Retrieves the distance to a specific world

# paths./worlds/{world_id}/polls/.get.description
Retrieves the list polls avaiable for give World

# paths./worlds/{world_id}/polls/.get.parameters[].description
The initial index from which to return the results.

# paths./worlds/{world_id}/polls/.get.parameters[].description
Filters based on a given time contraint. `time_after` sets lower bound and `time_before` sets upper bound. Format is ISO 8601

# paths./worlds/{world_id}/polls/.get.parameters[].description
Bucket size. Example `1 day`, `4 hours`. Bucket filter only applies to `/stats` endpoint

# paths./worlds/{world_id}/polls/{id}/.get.description
Retrieves a specific poll for a given world

Can pass `latest` or `initial` in place of `id` to retrieve the
newest or first one

# paths./worlds/{world_id}/polls/{id}/.get.parameters[].description
A unique integer value identifying this world poll.

# paths./worlds/{world_id}/polls/{id}/.get.parameters[].description
Filters based on a given time contraint. `time_after` sets lower bound and `time_before` sets upper bound. Format is ISO 8601

# paths./worlds/{world_id}/polls/{id}/.get.parameters[].description
Bucket size. Example `1 day`, `4 hours`. Bucket filter only applies to `/stats` endpoint

# paths./worlds/{world_id}/polls/{id}/leaderboard/.get.description
Retrieves the leaderboard for a given world poll result

# paths./worlds/{world_id}/polls/{id}/leaderboard/.get.parameters[].description
A unique integer value identifying this world poll.

# paths./worlds/{world_id}/polls/{id}/resources/.get.description
Retrieves the count of resources for a given world poll result

# paths./worlds/{world_id}/polls/{id}/resources/.get.parameters[].description
A unique integer value identifying this world poll.

# paths./forum/.post.description
Generates a Discourse markdown template ready to be posted on the
Boundless forums for a world.

# components.schemas.BlockColor.properties.active.description
Is this the current color for the world?

# components.schemas.BlockColor.properties.is_default.description
Is this the color the world spawned with?

# components.schemas.BlockColor.properties.is_sovereign_only.description
Is this color only on Sovereigns (and not Homeworlds)?

# components.schemas.BlockColor.properties.is_new.description
Is this the first time the color has been seen (only Homeworld/Sovereign)?

# components.schemas.BlockColor.properties.is_new_exo.description
Is this the first time the color has been seen (including Exo)?

# components.schemas.BlockColor.properties.is_new_transform.description
Is this the first time the color has been seen (including recipe transforms)?

# components.schemas.BlockColor.properties.days_since_exo.description
Days since last Exoworld that had this color

# components.schemas.BlockColor.properties.days_since_transform_exo.description
Days since last Exoworld had this color (including recipe transforms)

# components.schemas.BlockColor.properties.transform_first_world.description
First world that had this color (including recipe transforms)

# components.schemas.BlockColor.properties.transform_last_exo.description
Last Exoworld that had this color (including recipe transforms)

# components.schemas.Item.properties.resource_data.properties.max_tier.description
Max tier of world to be found on. Starts at 0.

# components.schemas.Item.properties.resource_data.properties.min_tier.description
Min tier of world to be found on. Starts at 0.

# components.schemas.Item.properties.resource_data.properties.best_max_tier.description
Max tier of world to be found on. Starts at 0.

# components.schemas.Item.properties.resource_data.properties.best_min_tier.description
Min tier of world to be found on. Starts at 0.

# components.schemas.ItemColor.properties.active.description
Is this the current color for the world?

# components.schemas.ItemColor.properties.is_default.description
Is this the color the world spawned with?

# components.schemas.ItemColor.properties.is_sovereign_only.description
Is this color only on Sovereigns (and not Homeworlds)?

# components.schemas.ItemColor.properties.is_new.description
Is this the first time the color has been seen (only Homeworld/Sovereign)?

# components.schemas.ItemColor.properties.is_new_exo.description
Is this the first time the color has been seen (including Exo)?

# components.schemas.ItemColor.properties.is_new_transform.description
Is this the first time the color has been seen (including recipe transforms)?

# components.schemas.ItemColor.properties.days_since_exo.description
Days since last Exoworld that had this color

# components.schemas.ItemColor.properties.days_since_transform_exo.description
Days since last Exoworld had this color (including recipe transforms)

# components.schemas.ItemColor.properties.transform_first_world.description
First world that had this color (including recipe transforms)

# components.schemas.ItemColor.properties.transform_last_exo.description
Last Exoworld that had this color (including recipe transforms)

# components.schemas.WorldColor.properties.active.description
Is this the current color for the world?

# components.schemas.WorldColor.properties.is_default.description
Is this the color the world spawned with?

# components.schemas.WorldColor.properties.is_sovereign_only.description
Is this color only on Sovereigns (and not Homeworlds)?

# components.schemas.WorldColor.properties.is_new.description
Is this the first time the color has been seen (only Homeworld/Sovereign)?

# components.schemas.WorldColor.properties.is_new_exo.description
Is this the first time the color has been seen (including Exo)?

# components.schemas.WorldColor.properties.is_new_transform.description
Is this the first time the color has been seen (including recipe transforms)?

# components.schemas.WorldColor.properties.days_since_exo.description
Days since last Exoworld that had this color

# components.schemas.WorldColor.properties.days_since_transform_exo.description
Days since last Exoworld had this color (including recipe transforms)

# components.schemas.WorldColor.properties.transform_first_world.description
First world that had this color (including recipe transforms)

# components.schemas.WorldColor.properties.transform_last_exo.description
Last Exoworld that had this color (including recipe transforms)

# components.schemas.Skill.properties.number_unlocks.description
How many times this skill can be unlocked

# components.schemas.SimpleWorld.properties.active.description
Does this world still exist (returned by game API)?

# components.schemas.World.properties.active.description
Does this world still exist (returned by game API)?

# components.schemas.World.properties.protection_points.description
'points' are not equal to levels in skill. For more details see this forum post.

# components.schemas.WorldBlockColor.properties.active.description
Is this the current color for the world?

# components.schemas.WorldBlockColor.properties.is_default.description
Is this the color the world spawned with?

# components.schemas.WorldBlockColor.properties.is_sovereign_only.description
Is this color only on Sovereigns (and not Homeworlds)?

# components.schemas.WorldBlockColor.properties.is_new.description
Is this the first time the color has been seen (only Homeworld/Sovereign)?

# components.schemas.WorldBlockColor.properties.is_new_exo.description
Is this the first time the color has been seen (including Exo)?

# components.schemas.WorldBlockColor.properties.is_new_transform.description
Is this the first time the color has been seen (including recipe transforms)?

# components.schemas.WorldBlockColor.properties.days_since_exo.description
Days since last Exoworld that had this color

# components.schemas.WorldBlockColor.properties.days_since_transform_exo.description
Days since last Exoworld had this color (including recipe transforms)

# components.schemas.WorldBlockColor.properties.transform_first_world.description
First world that had this color (including recipe transforms)

# components.schemas.WorldBlockColor.properties.transform_last_exo.description
Last Exoworld that had this color (including recipe transforms)

# components.schemas.ForumFormatPost.properties.world_id.description
World ID of given world. You can get your World ID from the Debug Menu if you are on PC

# components.schemas.ForumFormatPost.properties.username.description
Your Boundless Username. Required for Sovereign worlds.

# components.schemas.ForumFormatPost.properties.will_renew.description
Do you plan to renew this world? Required for Sovereign worlds.

# components.schemas.ForumFormatPost.properties.can_visit.description
Can Everyone warp/use portals to your world? Required for Sovereign worlds.

# components.schemas.ForumFormatPost.properties.can_edit.description
Can Everyone edit blocks on your world (outside of plots)? Required for Sovereign worlds.

# components.schemas.ForumFormatPost.properties.can_claim.description
Can Everyone create beacon and plot on your world? Required for Sovereign worlds.

# components.schemas.ForumFormatPost.properties.portal_directions.description
Directions to help players find the portal to your world.Required for Sovereign worlds.

# components.schemas.ForumFormatPost.properties.update_link.description
Add update link to easily update the template?