Coins

Coins are a type of redeemable that can be redeemed when a player is currently at a park - they can only be redeemed once until the same coin has been automatically generated again. On this page we'll dive into the different coin endpoints you can use to manage coins programmatically.

The coin model

The coin model contains all the information about coins.

Properties

Name
id
Type
integer
Description
Unique identifier for the coin.
Name
latitude
Type
integer
Description
Latitude for the coin.
Name
longitude
Type
integer
Description
Longitude for the coin.
Name
active_from
Type
timestamp
Description
Timestamp from when the coin was active.
Name
active_to
Type
timestamp
Description
Timestamp from when the coin became inactive.
Name
coins
Type
integer
Description
In-game coin currency for the coins.
Name
experience
Type
integer
Description
Experience for the coin.

POST/coins/:id/redeem

Redeem a coin

This endpoint allows you to redeem a coin that is currently an active redeemable for the authenticated player.

Optional attributes

Name
double_xp
Type
boolean
Description
Determines if the XP earned should be doubled.

Request

POST

/coins/1/redeem

curl https://prod-app.themeparkshark.com/api/coins/1/redeem \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d double_xp=true

Response

{
  "data": {
    "id": 1,
    "latitude": 33.80585,
    "longitude": -117.91869,
    "active_from": "2023-09-16T10:44:12.000000Z",
    "active_to": "2023-09-16T10:48:30.000000Z",
    "coins": 50,
    "experience": 100
  }
}