Skip to main content
POST
/
assignmentprogram
/
add
Add assignment preference
curl --request POST \
  --url https://futures.kraken.com/derivatives/api/v3/assignmentprogram/add \
  --header 'APIKey: <api-key>' \
  --header 'Authent: <api-key>'
{
  "id": 123,
  "participant": {
    "contractType": "flex",
    "contract": "PF_BTCUSD",
    "maxPosition": 10,
    "maxSize": 10,
    "acceptLong": true,
    "acceptShort": true,
    "timeFrame": "weekdays",
    "enabled": true
  },
  "result": "success",
  "serverTime": "2020-08-27T17:03:33.196Z"
}

Authorizations

​
APIKey
string
header
required

General API key with at least read-only access

​
Authent
string
header
required

Authentication string

Query Parameters

​
contractType
string
required

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
boolean
required

Accept to take long positions

​
acceptShort
boolean
required

Accept to take short positions

​
timeFrame
string
required

When is the program preference valid

​
enabled
boolean
required

enabled assignment

Response

200 - application/json
​
id
number
required
​
participant
object
required
Example:
{
  "contractType": "flex",
  "contract": "PF_BTCUSD",
  "maxPosition": 10,
  "maxSize": 10,
  "acceptLong": true,
  "acceptShort": true,
  "timeFrame": "weekdays",
  "enabled": true
}
​
result
enum<string>
required
Available options:
success
Example:

"success"

​
serverTime
string<date-time>
required

Server time in Coordinated Universal Time (UTC)

Example:

"2020-08-27T17:03:33.196Z"