Get currency offer template
curl --request GET \
--url https://api.gameboost.com/v2/currency-offers/templates/{game} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gameboost.com/v2/currency-offers/templates/{game}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.gameboost.com/v2/currency-offers/templates/{game}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gameboost.com/v2/currency-offers/templates/{game}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.gameboost.com/v2/currency-offers/templates/{game}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.gameboost.com/v2/currency-offers/templates/{game}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gameboost.com/v2/currency-offers/templates/{game}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"template": {
"game": "world-of-warcraft",
"currency_unit": "fc-coins",
"currency_unit_id": 48,
"currency_units": [
{
"id": 48,
"slug": "fc-coins",
"currency_name": "Coins",
"is_default": true
},
{
"id": 130,
"slug": "fc-points",
"currency_name": "Points",
"is_default": false
}
],
"description": "Sample currency offer description",
"price": 0.123456,
"currency": "EUR/USD (optional, defaults to EUR; USD will be converted to EUR)",
"stock": 1000,
"min_quantity": 1,
"allows_volume_discounts": true,
"volume_discounts": [
{
"min_quantity": 5000,
"percent": 5
},
{
"min_quantity": 10000,
"percent": 10
},
{
"min_quantity": 25000,
"percent": 15
}
],
"delivery_time": {
"duration": 30,
"unit": "minutes/hours/days"
},
"delivery_instructions": "(optional) Sample delivery instructions",
"delivery_method": "(optional, nullable) none/username/login/trade/auction/gift/redeem/mail",
"excluded_delivery_fields": [
"username"
],
"delivery_method_options": [
{}
],
"currency_data": {}
}
}{
"message": "Unauthenticated."
}{
"message": "Resource not found."
}{
"message": "Too many requests."
}Currency Offers
Get currency offer template
Retrieve a game-specific template with required and optional fields for creating a currency offer. For games with multiple currency units (for example FC 26 Coins and Points), the response includes currency_units. Pass currency_unit as a query parameter to get that unit’s currency_data schema.
GET
/
v2
/
currency-offers
/
templates
/
{game}
Get currency offer template
curl --request GET \
--url https://api.gameboost.com/v2/currency-offers/templates/{game} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gameboost.com/v2/currency-offers/templates/{game}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.gameboost.com/v2/currency-offers/templates/{game}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gameboost.com/v2/currency-offers/templates/{game}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.gameboost.com/v2/currency-offers/templates/{game}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.gameboost.com/v2/currency-offers/templates/{game}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gameboost.com/v2/currency-offers/templates/{game}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"template": {
"game": "world-of-warcraft",
"currency_unit": "fc-coins",
"currency_unit_id": 48,
"currency_units": [
{
"id": 48,
"slug": "fc-coins",
"currency_name": "Coins",
"is_default": true
},
{
"id": 130,
"slug": "fc-points",
"currency_name": "Points",
"is_default": false
}
],
"description": "Sample currency offer description",
"price": 0.123456,
"currency": "EUR/USD (optional, defaults to EUR; USD will be converted to EUR)",
"stock": 1000,
"min_quantity": 1,
"allows_volume_discounts": true,
"volume_discounts": [
{
"min_quantity": 5000,
"percent": 5
},
{
"min_quantity": 10000,
"percent": 10
},
{
"min_quantity": 25000,
"percent": 15
}
],
"delivery_time": {
"duration": 30,
"unit": "minutes/hours/days"
},
"delivery_instructions": "(optional) Sample delivery instructions",
"delivery_method": "(optional, nullable) none/username/login/trade/auction/gift/redeem/mail",
"excluded_delivery_fields": [
"username"
],
"delivery_method_options": [
{}
],
"currency_data": {}
}
}{
"message": "Unauthenticated."
}{
"message": "Resource not found."
}{
"message": "Too many requests."
}Some games have more than one currency unit (for example FC 26 has
fc-coins and fc-points).
Always read template.currency_units first. Then request the template again with
?currency_unit={slug} so currency_data matches that unit.Example: list units for a game
curl -X GET "https://api.gameboost.com/v2/currency-offers/templates/fc-26" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Accept: application/json"
{
"template": {
"game": "fc-26",
"currency_unit": "fc-coins",
"currency_unit_id": 48,
"currency_units": [
{
"id": 48,
"slug": "fc-coins",
"currency_name": "Coins",
"is_default": true
},
{
"id": 130,
"slug": "fc-points",
"currency_name": "Points",
"is_default": false
}
],
"currency_data": {
"platform": { "condition": "required", "values": ["PC", "PlayStation", "Xbox", "Switch"] }
}
}
}
Example: Points template
curl -X GET "https://api.gameboost.com/v2/currency-offers/templates/fc-26?currency_unit=fc-points" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Accept: application/json"
currency_data then includes unit-specific fields such as game_device and fc_points (not Coins platform).Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The slug of the game. Can be retrieved from the list of games.
Query Parameters
Currency unit slug (e.g. fc-coins, fc-points). Defaults to the game's default unit.
Example:
"fc-points"
Response
Currency offer creation template for a specific game
Show child attributes
Show child attributes
Was this page helpful?
⌘I