Helpdesk
  • Overview
    • Welcome to Finery Markets
    • About Our Products
      • FM Liquidity Match
        • Master Account
        • Sub-Account
      • FM Pulse
      • White Label solution
  • Product Features
    • Onboarding
    • Risk Management
    • Trading
      • Aggregated Order Book
      • Firm Order Book
      • Pending Limit Orders (GTC)
      • Quote streams
      • RFQ
      • Toxic Flow Protection
      • Markups
      • Authorized trading
      • Non-Deliverable Trading
      • Voice Trading
      • Interdealer Trading
    • Position Management
    • Settlements
      • Automated Settlements
      • Addresses
    • Control Center
      • Multi-Roles
      • Notifications
      • Reporting
      • Bulk Edit
    • Referral program
  • API Reference
    • Quick Start with API
      • For Market Makers
      • For Takers
    • Data Types
    • REST API
      • Client management
        • connectCounterparty
        • cancelConnectionInvite
        • getCounterpartyInfo
        • getSubaccounts
      • Trading
        • Order Book & QS
          • add
          • add (authorized)
          • Pending limit orders
            • add (pending limit order)
            • add (pending limit order) (authorized)
            • del
            • del (authorized)
            • delAll
            • delAll (authorized)
            • orders
            • orders (authorized)
          • mod
          • del
          • delAll
          • book
          • voiceTrade
          • liquidationTrade
          • dealHistory
          • dealHistory (authorized)
          • instruments
          • positions
          • instrumentMarkups
          • addInstrumentMarkups
          • delInstrumentMarkups
          • qs/getAvailableQsProviders
        • RFQ
          • getSettings
          • getSettings (authorized)
          • getUserSettings (authorized)
          • setUserSettings (authorized)
          • getProviders
          • getSessions
      • Settlements
        • settlementRequests
        • settlementOrders
        • settlementTransactions
        • settlementHistory
        • settlementTransactionHistory
        • addIncomingSettlementRequest
        • delIncomingSettlementRequest
        • delIncomingSettlementCPRequest
        • addOutgoingSettlementTransaction
        • addIncomingSettlementTransaction
        • sendSettlementTransaction
        • commitIncomingSettlementTransaction
        • delSettlementTransaction
      • Risk Management
        • climits
        • setCLimit
        • delCLimit
        • enableTrading
        • disableTrading
        • cAssetLimits
        • setCAssetLimit
        • delCAssetLimit
        • cShortSalesBan
        • setShortSalesBan
        • delShortSalesBan
        • enableInstrumentsWhitelist
        • setInstrumentsWhitelist
        • disableInstrumentsWhitelist
        • instrumentsWhitelist
      • Non-deliverable Trading
        • settings/getOvernightRates
        • settings/setOvernightRates
      • QS Stream Management
        • qs/addStream
        • qs/removeStream
        • qs/getStreams
        • qs/addTakerToStream
        • qs/delTakerFromStream
    • Websocket API
      • Feed 'A' - Assets
      • Feed 'P' - Positions
      • Feed 'L' - Counterparty limits
      • Feed 'B' - Global order books
      • Feed 'F' - Tradable order books
      • Feed 'R' - Settlement requests
      • Feed 'N' - Settlement transactions
      • Feed 'K' - Positions
      • Feed 'O' - Orders
      • Feed 'S' - Settlement orders
      • RFQ
      • QS for Liquidity Providers
        • Market Data
        • Trading
      • QS for Takers
        • Market Data
    • FIX API
      • Admin messages
      • Market Data
      • Trade
        • Trading for Takers
        • Trading for LPs and Masters
      • QS for Liquidity Providers
        • Market Data
        • Trading
      • QS for Takers
        • Market Data
    • Troubleshooting Errors
      • List of Error Codes
      • Error 3
      • Error 6
      • Error 7
      • Error 14
Powered by GitBook
On this page
  1. API Reference
  2. REST API
  3. Settlements

settlementHistory

Returns settlement history

POST api/settlementHistory

{
    "till": 12345,
    "limit": 10,
    "filterTransactions": false,
    "filter": "all"
}
[
    [
        1229,          // Settlement order id
        "BTC",         // Currency 1
        "USD",         // Currency 2
        10000000,      // Size 1
        100000000000,  // Size 2
        1558050900000, // Created at
        2,             // Counterparty id
        "Comment",     // Comment
        0,             // Flags
        1558051900000, // Settlement moment
        245,           // Settlement id
        "BTC",         // Network name 1
        "",            // Network name 2
    ]
]
{
    "error": 2
}

Request parameters

Field name
Type
Description

till

Efx::DealId

If specified only return settlements with lesser ID

from

Efx::Timestamp

If specified only return settlements with equal or greater creation timestamp

to

Efx::Timestamp

If specified only return settlements with lesser creation timestamp

limit

unsigned int16

Default: 250

Maximum number of settlements to return (capped at 250)

filterTransactions

bool

Optional. False by default. If true, returns settlement orders created without transaction.

filter

string

Optional field for master accounts only (FM Liquidity Match). - absent or "all": returns settlements for all counterparties - "subaccounts": returns settlements for the sub-accounts - "external": returns settlements for external counterparties

Response description

Field name
Type
Description

Array of settlements

Settlement

Array[13]

0

Efx::OrderId

Settlement Order Id

1

string

Currency 1

2

string

Currency 2

3

Efx::Size

Size 1

4

Efx::Size

Size 2

5

Efx::Timestamp

Created At

6

Efx::ClientId

Counterparty Id

7

string

Comment

8

unsigned int16

Flags

9

Efx::Timestamp

Settlement Moment

10

Efx::DealId

Settlement Id

11

string

Network name 1 or empty

12

string

Network name 2 or empty

PrevioussettlementTransactionsNextsettlementTransactionHistory

Last updated 11 months ago