Foxbit Python SDK

This is the official SDK provided by Foxbit for interacting with our APIs using Python.

Prerequisites

• Python 3.9 or higher
• pip

Installation

Install the SDK using pip:

pip install foxbit-group-rest-api

How to Use

To start using the SDK, import the desired API module and call its methods:

from foxbit_group.rest_api import ApiClient
from foxbit_group.rest_api.api import MarketDataApi

with ApiClient() as client:
    market_data_api = MarketDataApi(client)

    currencies = market_data_api.list_currencies()
    print("Currencies:", currencies)

For public endpoints that don't require authentication, you can use the SDK without any configuration.

Authentication

For authenticated endpoints, instantiate a Configuration object with your API credentials and pass it to ApiClient:

from foxbit_group.rest_api import ApiClient, Configuration
from foxbit_group.rest_api.api import TradingApi
from foxbit_group.rest_api.models import CreateOrderRequest, OrderMarket

# Initialize the configuration with your API key and secret
config = Configuration(
    api_key="YOUR_API_KEY",
    api_secret="YOUR_API_SECRET",
)

with ApiClient(config) as client:
    trading_api = TradingApi(client)

    # CreateOrderRequest wraps one of the concrete order types
    # (OrderMarket, OrderLimit, OrderInstant, OrderStop, OrderStopLimit)
    order = trading_api.create_order(
        create_order_request=CreateOrderRequest(
            OrderMarket(
                side="BUY",
                type="MARKET",
                market_symbol="btcbrl",
                quantity="1",
            )
        )
    )
    print("Order created:", order)

The SDK will automatically:

1. Generate the current timestamp
2. Create the request signature using your API secret (HMAC-SHA256)
3. Add the required headers to each request:
   • X-FB-ACCESS-KEY: Your API key
   • X-FB-ACCESS-TIMESTAMP: Current timestamp
   • X-FB-ACCESS-SIGNATURE: Signature generated from your API secret

Your api_secret is only used locally to sign requests; it is never sent over the wire.

Note on retries: the signature and timestamp are computed once, when the request is serialized. If you enable transport-level retries (Configuration(retries=...)), a retried attempt replays the original timestamp and may be rejected as expired. Prefer retrying at the call site (call the SDK method again) so each attempt is signed afresh.

Error Handling

API errors raise typed exceptions, all inheriting from ApiException:

from foxbit_group.rest_api import ApiClient, Configuration
from foxbit_group.rest_api.api import TradingApi
from foxbit_group.rest_api.exceptions import ApiException, UnauthorizedException

config = Configuration(api_key="YOUR_API_KEY", api_secret="YOUR_API_SECRET")

with ApiClient(config) as client:
    try:
        orders = TradingApi(client).list_orders()
    except UnauthorizedException:
        print("Invalid credentials or rejected signature")
    except ApiException as e:
        print(f"API error: {e.status} - {e.body}")

Documentation for API Endpoints

You can find detailed documentation for each API endpoint in the Foxbit API Documentation.

Each API class has its own page, with an example per method:

• AccountApi

• BanksApi

• DepositApi

• MarketDataApi

• MemberInfoApi

• PrimeDeskApi

• SystemApi

• TradingApi

• TransactionalLimitsApi

• TravelRuleApi

• WithdrawalApi

Documentation for Models

• Account

• Accounts

• Bank

• BankAccount

• BankAccountData

• BankBranch

• BankData

• Banks

• BeneficiaryOwnExchangeWallet

• BeneficiaryOwnPrivateWallet

• BeneficiaryThirdPartyExchangeWallet

• BeneficiaryThirdPartyPrivateWallet

• Best

• BestSide

• BestSideWithVolume

• BestWithVolume

• CancelOrdersRequest

• CandlestickInner

• CreateDepositTravelRuleRequest

• CreateOrderRequest

• CreateWithdrawalRequest

• Currencies

• Currency

• CurrencyCategory

• CurrencyDepositInfo

• CurrencyNetwork

• CurrencyWithdrawInfo

• Deposit

• DepositAddress

• DepositTravelRuleResponse

• Deposits

• DetailsCrypto

• DetailsWithdrawCrypto

• DetailsWithdrawCryptoTag

• ErrorData

• ErrorDetails

• ErrorResponse

• ExecuteQuoteCreatedModel

• Fees

• GetTickerResponse

• GetTickerWithBestResponse

• LastTrade

• Market

• MarketCurrency

• MarketModel

• Markets

• MarketsBaseCurrencyModel

• MarketsQuoteCurrencyModel

• MarketsResponseModel

• Member

• Network

• NetworkDepositInfo

• NetworkWithdrawInfo

• OperationReason

• OperationReasons

• Order

• OrderBatchResponse

• OrderBatchResponseError

• OrderBatchResult

• OrderCancel

• OrderCancelReplace

• OrderCancelReplaceCancelResult

• OrderCancelReplaceCreateResult

• OrderCancelReplaceError

• OrderCanceled

• OrderCanceledReplaced

• OrderCreateBatchModel

• OrderCreated

• OrderInstant

• OrderLimit

• OrderMarket

• OrderStop

• OrderStopLimit

• OrderWithoutRemark

• OrderbookDepth

• Orders

• OrdersCancelAll

• OrdersCancelClientOrderId

• OrdersCancelId

• OrdersCancelMarket

• OrdersCancelMarketSide

• OrdersCancelSn

• OrdersCanceled

• OriginatorOwnExchangeWallet

• OriginatorOwnPrivateWallet

• OriginatorThirdPartyExchangeWallet

• OriginatorThirdPartyPrivateWallet

• PrimeDeskExecuteQuoteModel

• PrimeDeskExecutionHistoryData

• PrimeDeskExecutionHistoryModel

• PublicTrade

• PublicTrades

• Quote

• RequestForQuote

• RequestForQuoteByAmount

• RequestForQuoteByQuantity

• RequestForQuoteResponseModel

• Rolling24Hr

• Sparkline

• Sparkline400

• Sparkline400Error

• Sparklines

• SystemTime

• Ticker

• TickerWithBest

• Trade

• Trades

• TradingFee

• TradingFeesResponse

• Transaction

• TransactionalLimit

• TransactionalLimits

• TransactionalLimitsResponse

• TransactionsResponse

• TravelRuleInfoResponse

• UnauthorizedError

• UnauthorizedErrorResponse

• Withdrawal

• WithdrawalCreated

• WithdrawalCrypto

• WithdrawalFiat

• WithdrawalList

• WithdrawalTravelRule

• Withdrawals

About This SDK

This SDK was automatically generated using OpenAPI Generator.

Note: This SDK is actively maintained by the Foxbit team. For more information, visit https://foxbit.com.br.