sFOX API
Sign InOpen Account
sFOX API
sFOX API
  • Introduction
    • Welcome
    • Getting Started
    • Systems & Operations
    • Rate Limits
  • REST API
    • REST Endpoints
    • Authentication
    • Rate Limits
    • Account Management
      • Get All Balances
      • Get All Currencies
      • Get All Currency Pairs
      • Get All Transactions
      • Get Fees
    • Orders
      • Order Types
      • Create Order
      • Cancel Order
      • Cancel Multiple Orders
      • Cancel All Orders
      • Amend Order
      • Get Single Order
      • Get All Open Orders
      • Get All Done Orders
      • Get All Trades
    • Request for Quote (RFQ)
    • Post-Trade Settlement (PTS)
      • Get Account Risk Metrics
      • Get All Positions
      • Get All Funding Transactions
      • Get All Funding Rates
      • Get All Risk Modes
      • Create Transfer
    • Shorting
      • Get Account Risk Metrics
      • Get All Positions
    • Transfers
      • Get All Deposit Addresses
      • Get Single Deposit Address
      • Create Deposit Address
      • Deposit From Bank Account
      • Withdraw From Account
      • Get Single Withdrawal Fee
      • Create Transfer
    • Custody (sFOX SAFE)
      • Get Whitelisted Addresses
      • Add Whitelisted Address
      • Delete Whitelisted Address
      • Get Approval Rules
      • Create Approval Rule
      • Edit Approval Rule
      • Get Approval Requests
      • Respond to Approval Request
    • Staking
      • Get Staking Currencies
      • Get All Staking Transactions
      • Create Stake
      • Cancel Stake
      • Unstake
    • Market Data
      • Get Candlesticks
      • Get Volume Analytics
      • Get Order Estimate
      • Get Order Book
    • Reporting
      • Get Orders Report
      • Get Monthly Summary
      • Get Portfolio Valuation
      • Get All Transactions
  • WebSocket API
    • Introduction
    • Connecting
    • Rate Limits
    • Authentication
    • Subscribing & Unsubscribing
    • Message Format
    • Market Data
      • Order Book
      • Trades
      • Ticker
    • Orders & Account Data
      • Orders
      • Trades
      • Balances
      • Post-Trade Settlement
  • FIX API
    • FIX Order Entry
    • FIX Market Data
    • QuickFIX Guide
  • Errors
    • Error Codes
Powered by GitBook
  1. REST API
  2. Custody (sFOX SAFE)

Get Approval Requests

GET https://api.sfox.com/v1/approvals

Retrieve a list of approval requests.

Query Parameters

Parameter
Type
Description

pending

boolean

When set to true will only return pending approvals, otherwise all approvals both completed and pending will be returned.

Responses

200
{
    "data": [
      {
        "approval_id": 1,
        "requested_by_username": "example@email.com",
        "requested_by_uaid": "6ea3fb9e-7797-11eb-aa51-0242ac120002",
        "date_added": "2021-03-03T20:28:41.000Z",
        "status": "Pending",
        "approval_type": "WITHDRAW",
        "required_approvals": 2,
        "received_approvals": 0,
        "action_details": {
          "atx_currency_code": "btc",
          "atx_amount": 5,
          "atx_dest_address": "0x1232131223",
          "threshold": 1
        },
        "approval_responses": {
          "ua_display_id": "3fb9e6ea-7797-11eb-aa51-200020242ac1",
          "username": "collaborator@email.com",
          "approved": true
        }
    ]
}

Example Requests

curl -H 'Authorization: Bearer <API_TOKEN>' \
 'https://api.sfox.com/v1/approvals'
import requests

data = requests.get(
  "https://api.sfox.com/v1/approvals",
  headers={
    "Authorization": "Bearer <API_KEY>",
  }
)
print(data)
import requests

data = requests.get(
  "https://api.sfox.com/v1/approval-rules",
  headers={
    "Authorization": "Bearer <API_KEY>",
  }
)
print(data)
PreviousEdit Approval RuleNextRespond to Approval Request

Last updated 1 year ago