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. Client management

getCounterpartyInfo

Returns information about one or all connected and invited counterparties.

POST /getCounterpartyInfo

{
    "counterpartyId": 5 // Optional
}
[
    {
        "clientId": 5,
        "clientType": "taker",
        "username": "Some User",
        "subaccount": true,
        "status": "connected",
        "disabled": false
    },
    ...
]
{
  "error": 0
}

Request parameters

Field name
Type
Description

counterpartyId

Efx::ClientId

Optional. The FM ID of the counterparty whose information is to be fetched. If omitted, all known counterparties are returned.

Response description

Field name
Type
Description

clientId

Efx::ClientId

Id of the connected client

clientType

string

Type of the connected client: "maker", "taker" or "master"

username

string

Optional. Username of the counterparty. Visible only if the counterparty sent or accepted a connection request.

subaccount

bool

Optional. True and present only if the counterparty is a subaccount.

status

string

Connection status: "connected" - connection request has been accepted. "invite_sent" - you have sent an invitation to connect, but it has not been accepted yet. "invite_pending" - a counterparty sent you an invitation to connect.

disabled

bool

True if the client is disabled. Trading is not allowed with disabled clients.

PreviouscancelConnectionInviteNextgetSubaccounts

Last updated 3 days ago