Add assignment preference - Kraken Developers

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>'

import requests

url = "https://futures.kraken.com/derivatives/api/v3/assignmentprogram/add"

headers = {
    "APIKey": "<api-key>",
    "Authent": "<api-key>"
}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {APIKey: '<api-key>', Authent: '<api-key>'}};

fetch('https://futures.kraken.com/derivatives/api/v3/assignmentprogram/add', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://futures.kraken.com/derivatives/api/v3/assignmentprogram/add"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("APIKey", "<api-key>")
	req.Header.Add("Authent", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "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

Success Response
Errors

id

number

required

participant

object

required

Show child attributes

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"

⌘I

Add assignment preference

curl --request POST \
  --url https://futures.kraken.com/derivatives/api/v3/assignmentprogram/add \
  --header 'APIKey: <api-key>' \
  --header 'Authent: <api-key>'

import requests

url = "https://futures.kraken.com/derivatives/api/v3/assignmentprogram/add"

headers = {
    "APIKey": "<api-key>",
    "Authent": "<api-key>"
}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {APIKey: '<api-key>', Authent: '<api-key>'}};

fetch('https://futures.kraken.com/derivatives/api/v3/assignmentprogram/add', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://futures.kraken.com/derivatives/api/v3/assignmentprogram/add"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("APIKey", "<api-key>")
	req.Header.Add("Authent", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "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"
}