public/fork_token

Generates a token for a new named session. This method can be used only with session scoped tokens.

📖 More Details: Fork and Exchange Tokens

Try in API console

cURL

cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/public/fork_token \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 7620,
  "method": "public/fork_token",
  "params": {
    "refresh_token": "1568800656974.1CWcuzUS.MGy49NK4hpTwvR1OYWfpqMEkH4T4oDg4tNIcrM7KdeyxXRcSFqiGzA_D4Cn7mqWocHmlS89FFmUYcmaN2H7lNKKTnhRg5EtrzsFCCiuyN0Wv9y-LbGLV3-Ojv_kbD50FoScQ8BDXS5b_w6Ir1MqEdQ3qFZ3MLcvlPiIgG2BqyJX3ybYnVpIlrVrrdYD1-lkjLcjxOBNJvvUKNUAzkQ",
    "session_name": "forked_session_name"
  }
}
'

200

{
  "jsonrpc": "2.0",
  "id": 9929,
  "result": {
    "access_token": "1582628593469.1MbQ-J_4.CBP-OqOwm_FBdMYj4cRK2dMXyHPfBtXGpzLxhWg31nHu3H_Q60FpE5_vqUBEQGSiMrIGzw3nC37NMb9d1tpBNqBOM_Ql9pXOmgtV9Yj3Pq1c6BqC6dU6eTxHMFO67x8GpJxqw_QcKP5IepwGBD-gfKSHfAv9AEnLJkNu3JkMJBdLToY1lrBnuedF3dU_uARm",
    "expires_in": 31536000,
    "refresh_token": "1582628593469.1GP4rQd0.A9Wa78o5kFRIUP49mScaD1CqHgiK50HOl2VA6kCtWa8BQZU5Dr03BhcbXPNvEh3I_MVixKZXnyoBeKJwLl8LXnfo180ckAiPj3zOclcUu4zkXuF3NNP3sTPcDf1B3C1CwMKkJ1NOcf1yPmRbsrd7hbgQ-hLa40tfx6Oa-85ymm_3Z65LZcnCeLrqlj_A9jM",
    "scope": "session:named_session mainaccount",
    "token_type": "bearer"
  }
}

Query Parameters

refresh_token · string · required

Refresh token

Example:

"1568800656974.1CWcuzUS.MGy49NK4hpTwvR1OYWfpqMEkH4T4oDg4tNIcrM7KdeyxXRcSFqiGzA_D4Cn7mqWocHmlS89FFmUYcmaN2H7lNKKTnhRg5EtrzsFCCiuyN0Wv9y-LbGLV3-Ojv_kbD50FoScQ8BDXS5b_w6Ir1MqEdQ3qFZ3MLcvlPiIgG2BqyJX3ybYnVpIlrVrrdYD1-lkjLcjxOBNJvvUKNUAzkQ"

session_name · string · required

New session name

Example:

"forked_session_name"

Response

200 - application/json

Success response

jsonrpc · enum<string> · required

The JSON-RPC version (2.0)

Available options: 2.0

result · object · required

Hide child attributes

result. access_token · string · required

Example:

"843SehgeX5n6XxEU4XbABx4Cny5Akai5iHiJePTsvUw7"

result. token_type · enum<string> · required

Authorization type, allowed value - bearer

Available options: bearer

result. expires_in · integer · required

Token lifetime in seconds

Example:

315360000

result. refresh_token · string · required

Can be used to request a new token (with a new lifetime)

Example:

"6faf8L36JdaSqsjCEEiwqifPpj6JB18RWwiWHrsGTZ91"

result. scope · string · required

Type of the access for assigned token

result. sid · string

Optional Session id

id · integer

The id that was sent in the request