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

Parameter	Description
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

Shell

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'

NodeJS

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);
  });

Python

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

Field	Description
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

200 OK

{
  "data": [
    {
        "monetization_id": 1310717,
        "monetization_feature": "Spot Trading",
        "monetization_feature_code": "SPOT_TRADE",
        "monetization_method": "Fee Rate",
        "monetization_method_code": "FEE_RATE",
        "monetization_amount": 0.01,
        "user_id": "client25",
        "currency_code": null,
        "security_pair_raw": null,
        "date_updated": "2023-06-07T21:49:22.000Z"
    },
    {
        "monetization_id": 1310720,
        "monetization_feature": "Request for Quote",
        "monetization_feature_code": "RFQ",
        "monetization_method": "Spread Adjustment",
        "monetization_method_code": "SPREAD_ADJUSTMENT",
        "monetization_amount": 0.01,
        "user_id": null,
        "currency_code": null,
        "security_pair_raw": null,
        "date_updated": "2023-06-07T22:49:22.000Z"
    }
  ]
}