Get PNL currency preference for a market

GET 
/pnlpreferences

The PNL currency preference is used to determine which currency to pay out when realizing PNL gains.

Responses

200

OK

application/json

Schema

Schema

oneOf

Success Response

preferences object[]

Array [

symbol string

pnlCurrency string

]

result stringrequired

Possible values: [success]

serverTime date-timerequired

Server time in Coordinated Universal Time (UTC)

ErrorResponse

errors Error (string)[]

Possible values: [accountInactive, apiLimitExceeded, authenticationError, insufficientFunds, invalidAccount, invalidAmount, invalidArgument, invalidUnit, Json Parse Error, marketUnavailable, nonceBelowThreshold, nonceDuplicate, notFound, requiredArgumentMissing, Server Error, Unavailable, unknownError]

error Error (string)

Possible values: [accountInactive, apiLimitExceeded, authenticationError, insufficientFunds, invalidAccount, invalidAmount, invalidArgument, invalidUnit, Json Parse Error, marketUnavailable, nonceBelowThreshold, nonceDuplicate, notFound, requiredArgumentMissing, Server Error, Unavailable, unknownError]

Error description.

• accountInactive: The Futures account the request refers to is inactive
• apiLimitExceeded: The API limit for the calling IP address has been exceeded
• authenticationError: The request could not be authenticated
• insufficientFunds: The amount requested for transfer is below the amount of funds available
• invalidAccount: The Futures account the transfer request refers to is invalid
• invalidAmount: The amount the transfer request refers to is invalid
• invalidArgument: One or more arguments provided are invalid
• invalidUnit: The unit the transfer request refers to is invalid
• Json Parse Error: The request failed to pass valid JSON as an argument
• marketUnavailable: The market is currently unavailable
• nonceBelowThreshold: The provided nonce is below the threshold
• nonceDuplicate: The provided nonce is a duplicate as it has been used in a previous request
• notFound: The requested information could not be found
• requiredArgumentMissing: One or more required arguments are missing
• Server Error: There was an error processing the request
• Unavailable: The endpoint being called is unavailable
• unknownError: An unknown error has occurred

result stringrequired

Possible values: [error]

serverTime date-timerequired

Server time in Coordinated Universal Time (UTC)

success

{
  "result": "success",
  "serverTime": "2022-06-28T15:04:06.710Z",
  "preferences": [
    {
      "symbol": "PF_XBTUSD",
      "pnlCurrency": "BTC"
    }
  ]
}

Loading...