Adds an assignment program preference

POST 
/assignmentprogram/add

This endpoint adds an assignment program preference

Request

application/json

Body

required

contractType stringrequired

Type of contract for the assignment program preference. Options can be found in the 'accounts' structure in the Get Wallets /accounts response

contract string

A specific contract for this assignment program preference. Required for "flex" contracts if base/quote currencies are not included.

maxSize number

The maximum size for an assignment

maxPosition number

The maximum position

acceptLong booleanrequired

Accept to take long positions

acceptShort booleanrequired

Accept to take short positions

timeFrame stringrequired

When is the program preference valid

enabled booleanrequired

enabled assignment

Responses

200

application/json

Schema

Schema

oneOf

Success Response

id number

participant object

contractType string

contract stringnull

maxSize double

maxPosition double

acceptLong boolean

acceptShort boolean

timeFrame string

Possible values: [all, weekdays, weekends]

enabled boolean

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)

Loading...