Get Currency Offer

curl --request GET \
  --url https://api.gameboost.com/v1/currency-offers/{currencyOfferId} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "<string>",
    "type": "currencyOffers",
    "attributes": {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "game_slug": "<string>",
      "currency_unit": {
        "currency_name": "<string>",
        "name": "<string>",
        "symbol": "<string>",
        "multiplier": 123
      },
      "description": "<string>",
      "price": 123,
      "stock": 123,
      "min_quantity": 123,
      "data": {},
      "delivery_time": {
        "duration": 123,
        "unit": "minutes",
        "format": "<string>",
        "formatLong": "<string>",
        "seconds": 123
      },
      "status": "listed",
      "created_at": "2023-11-07T05:31:56Z",
      "listed_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  }
}

GET

currency-offers

{currencyOfferId}

Get Currency Offer

curl --request GET \
  --url https://api.gameboost.com/v1/currency-offers/{currencyOfferId} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "<string>",
    "type": "currencyOffers",
    "attributes": {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "game_slug": "<string>",
      "currency_unit": {
        "currency_name": "<string>",
        "name": "<string>",
        "symbol": "<string>",
        "multiplier": 123
      },
      "description": "<string>",
      "price": 123,
      "stock": 123,
      "min_quantity": 123,
      "data": {},
      "delivery_time": {
        "duration": 123,
        "unit": "minutes",
        "format": "<string>",
        "formatLong": "<string>",
        "seconds": 123
      },
      "status": "listed",
      "created_at": "2023-11-07T05:31:56Z",
      "listed_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

currencyOfferId

integer

required

Response

Successfully retrieved the currency offer.

data

object

Show child attributes

data.id

string

Unique identifier for the currency offer.

data.type

enum<string>

Resource type, fixed as "currencyOffers".

Available options:

currencyOffers

data.attributes

object

Show child attributes

data.attributes.uuid

string<uuid>

Unique UUID for the currency offer.

data.attributes.title

string

Title of the currency offer.

data.attributes.game_slug

string

Slug representing the game associated with the currency offer.

data.attributes.currency_unit

object

Details of the currency unit.

Show child attributes

data.attributes.currency_unit.currency_name

string

Name of the currency (e.g., "Gold").

data.attributes.currency_unit.name

string

Unit name (e.g., "Thousand").

data.attributes.currency_unit.symbol

string

Symbol representing the unit (e.g., "K").

data.attributes.currency_unit.multiplier

integer

Multiplier value for the unit (e.g., 1000 for "Thousand").

data.attributes.description

string

Description of the currency offer.

data.attributes.price

number<float>

Price per unit of the currency offer in euro.

data.attributes.stock

integer

Available stock for the currency offer.

data.attributes.min_quantity

integer

Minimum purchase quantity for the currency offer.

data.attributes.data

object

Game specific data associated with the currency offer.

data.attributes.delivery_time

object

Details of the delivery time for the currency offer.

Show child attributes

data.attributes.delivery_time.duration

number

Duration for delivery.

data.attributes.delivery_time.unit

enum<string>

Unit of time for delivery duration.

Available options:

minutes,

hours,

days

data.attributes.delivery_time.format

string

Short formatted delivery time (e.g., "5 min").

data.attributes.delivery_time.formatLong

string

Long formatted delivery time (e.g., "5 minutes").

data.attributes.delivery_time.seconds

integer

Delivery time in seconds.

data.attributes.status

enum<string>

Status of the currency offer.

Available options:

listed,

draft,

archived

data.attributes.created_at

string<date-time>

Timestamp of when the currency offer was created.

data.attributes.listed_at

string<date-time>

Timestamp of when the currency offer was listed.

data.attributes.updated_at

string<date-time>

Timestamp of the last update to the currency offer.

Create Currency Offer Update Currency Offer

⌘I

Getting Started

REST API

Get Currency Offer

Authorizations

Path Parameters

Response