Get Settings
GET
https://api.sfox.com/v1/enterprise/monetization/settings
Retrieve a list of your monetization settings
This endpoint returns active monetization settings created by the Partner. Partners can filter by feature, method, user_id, or currency. An empty request body will return all active monetization settings for the Partner.
Request
Body Parameters
feature
string
Filter the response by this feature (e.g. SPOT_TRADE)
method
string
Filter the response by this method.
currency
string
Filter the response by this currency.
user_id
string
Filter the response by this user_id.
Example Requests
curl -X GET \
-H 'Content-type: application/json' \
-H "Authorization: Bearer ${ENTERPRISE_API_KEY}" \
--data '{ "feature": "SPOT_TRADE" }' \
'https://api.sfox.com/v1/enterprise/monetization/settings'const axios = require('axios');
const config = {
method: 'post',
url: 'https://api.sfox.com/v1/enterprise/monetization/settings',
headers: {
'Authorization': `Bearer ${process.env.ENTERPRISE_API_KEY}`
},
data: {
feature: 'SPOT_TRADE'
}
}
axios(config)
.then((response) => {
console.log(response.status);
console.log(response.data);
})
.catch((error) => {
console.error(error.response.status);
console.error(error.response.data);
});import requests
import os
data = requests.get(
"https://api.sfox.com/v1/enterprise/monetization/settings",
headers={
"Authorization": f"Bearer {os.environ['ENTERPRISE_API_KEY']}"
},
json={
"feature": "SPOT_TRADE"
}
)
print(data.status_code)
print(data.json())Response
Returns a data object list. Each object contains the following response fields.
Response Fields
monetization_id
int
Unique ID for this monetization setting.
monetization_feature
string
Feature this setting applies to.
monetization_feature_code
string
API readable code for the feature.
monetization_method
string
Monetization method of the setting.
monetization_method_code
string
API readable code for the monetization method.
monetization_amount
number
Monetization amount in decimal format.
user_id
string
User ID of the end user that the setting is applied to, if applicable. null if the setting applies to all end users.
currency_code
string
Currency that the setting is applied to, if applicable. null if the setting applies to all currencies or is not applicable to currencies.
currency_pair
string
Currency pair that the setting is applied to, if applicable. null if the setting applies to all pairs or is not applicable to currency pairs.
date_updated
datetime
Date and time the setting was most recently updated or created.
Responses
Last updated