sFOX API
Sign InOpen Account
Connect API
Connect API
  • Introduction
    • Welcome
    • Getting Started
    • Resources
      • Terminology
      • Systems & Operations
      • Integration Options
    • Guides
      • End User Onboarding & KYC
        • Individuals
        • Businesses
        • Enhanced Due Diligence
  • REST API
    • REST Endpoints
    • Authentication
    • End Users
      • Create End User Account
      • Request Verification Code
      • Confirm Verification Code
      • Create User Auth Token(s)
      • Get End User(s)
      • Get EDD Requests
      • Get EDD Prompts
      • Create EDD Responses
        • Uploading Files as Responses
      • Submit Documents
      • Deactivate User
    • Payments
      • Create Bank Account (Plaid)
      • Create Bank Account
      • Get Bank Account
      • Get Plaid Processors
      • Amend Plaid Processors
      • Verify Bank Account
      • Delete Bank Account
      • Get Wire Instructions
      • Get ACH Agreement Status
      • Request ACH Onboarding
      • Get ACH Deposit Limit
    • Withdrawals
      • Confirm Withdrawal
      • Resend Confirmation Code
      • Cancel Withdrawal
    • Transfers
      • Create Transfer
      • Confirm Transfer
      • Resend Confirmation Code
      • Cancel Transfer
      • Get Transfer Permissions
      • Get Transfer History
    • Monetization
      • Create Setting
      • Update Setting
      • Delete Setting
      • Get Settings
      • Get Permissions
      • Get Monetization History
  • WebSocket API
    • Connecting
    • Authentication
    • Subscribing & Unsubscribing
    • Message Format
    • End Users
      • Onboarding
      • Balances
      • Orders
      • Trades
    • Market Data
      • Order Book
      • Trades
      • Ticker
  • Single Sign-On
    • Overview
      • IdP Initiated SSO
    • IdP Data
    • SAML Response Data
  • Errors
    • Error Codes
Powered by GitBook
  1. REST API
  2. Monetization

Get Settings

GET https://api.sfox.com/v1/enterprise/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.

Body Parameters

Name
Type
Description

feature

string

A feature returns settings for that feature i.e. SPOT_TRADE

method

string

A method returns settings for that method i.e. FEE_RATE

currency

string

A currency returns settings for that currency. i.e. btc

user_id

string

A Connect user ID returns settings relative to a user

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"
    }
  ]
}

Response Body

Key
Description

monetization_id

Unique ID for this monetization setting

monetization_feature

Feature the fee will apply to

monetization_feature_code

API readable monetization feature

monetization_method

Monetization method of the setting

monetization_method_code

API readable monetization method

monetization_amount

Monetization amount in decimal format

user_id

User Id of the user that the fee is specified for

currency_code

Currency that the fee is specified for

currency_pair

Currency pair that the fee is specified for

date_updated

Date and time the fee was created or updated

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())
PreviousDelete SettingNextGet Permissions

Last updated 11 months ago