Issue an approved credential

POST

https://api.liftx.io

integrations

credentials

Issue credentials after exact fresh approval

curl --request POST \
  --url https://api.liftx.io/integrations/credentials \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "request": {
    "name": "<string>",
    "scopes": [],
    "exchange_link_ids": [
      4503599627370496
    ],
    "expires_at": 123,
    "instrument_ids": [
      "<string>"
    ],
    "integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
'

import requests

url = "https://api.liftx.io/integrations/credentials"

payload = {
    "operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "request": {
        "name": "<string>",
        "scopes": [],
        "exchange_link_ids": [4503599627370496],
        "expires_at": 123,
        "instrument_ids": ["<string>"],
        "integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    operation_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    request: {
      name: '<string>',
      scopes: [],
      exchange_link_ids: [4503599627370496],
      expires_at: 123,
      instrument_ids: ['<string>'],
      integration_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    }
  })
};

fetch('https://api.liftx.io/integrations/credentials', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "credential": {
    "id": "77777777-7777-4777-8777-777777777777",
    "integration_id": "88888888-8888-4888-8888-888888888888",
    "name": "Demo controller",
    "kind": "api",
    "prefix": "lx_api_77777777",
    "scopes": [
      "read",
      "positions:open",
      "positions:modify",
      "positions:terminate"
    ],
    "exchange_link_ids": [
      17
    ],
    "instrument_ids": [
      "COPY_EXACT_CATALOG_ID"
    ],
    "created_at": 1893456000,
    "expires_at": 1893542400,
    "revoked_at": null
  }
}

{
  "credential": {
    "id": "77777777-7777-4777-8777-777777777777",
    "integration_id": "88888888-8888-4888-8888-888888888888",
    "name": "Demo controller",
    "kind": "api",
    "prefix": "lx_api_77777777",
    "scopes": [
      "read",
      "positions:open",
      "positions:modify",
      "positions:terminate"
    ],
    "exchange_link_ids": [
      17
    ],
    "instrument_ids": [
      "COPY_EXACT_CATALOG_ID"
    ],
    "created_at": 1893456000,
    "expires_at": 1893542400,
    "revoked_at": null
  },
  "secret": "ONE_TIME_API_SECRET_FROM_AUTHENTICATED_SETTINGS"
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Preview contract. Production availability remains subject to activation and release qualification. Examples are synthetic; the documentation cannot submit requests.

Authorization

Authenticated Settings session and exact fresh purpose-bound approval.

Behavior

Submit the same operation_id and full approved request. A new issuance returns 201 with a one-time secret; a committed duplicate can return 200 metadata without recovering the secret. Do not automatically repeat after a lost response. This is a session-owned application contract, not an ordinary API-key endpoint. Use Settings → Integrations. The public API base URL does not grant session access.

JSON body example

The following shows the request shape, not live credentials or executable market defaults. Replace timestamps only when creating a new reviewed intent; never mutate them on a command retry.

{
  "operation_id": "66666666-6666-4666-8666-666666666666",
  "request": {
    "name": "Demo controller",
    "kind": "api",
    "scopes": [
      "read",
      "positions:open",
      "positions:modify",
      "positions:terminate"
    ],
    "exchange_link_ids": [
      17
    ],
    "instrument_ids": [
      "COPY_EXACT_CATALOG_ID"
    ],
    "expires_at": 1893542400
  }
}

Response and errors

The generated response schema below is the wire contract. Preserve fixed-point strings, nullable fields and endpoint-specific envelopes. Inspect HTTP status and Content-Type before decoding failures; reused trading routes may return JSON or plain text. Authentication, entitlement and exact link/instrument restrictions apply in addition to endpoint validation. See errors and recovery. Do not automatically repeat a mutation after transport ambiguity. Trading commands reuse the exact immutable identity; credential issuance and template writes require their documented metadata/read reconciliation. Read the related guide for lifecycle, units and recovery semantics.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

operation_id

string<uuid>

required

request

object

required

Show child attributes

Response

Committed duplicate; no secret recovery

Secret only on first successful issue; duplicates return metadata. Never automatically repeat issuance after ambiguity.

credential

object

required

Show child attributes

binding

object

Show child attributes

secret

string

read-only

One-time secret on successful first issuance only.

webhook_url

string<uri>

Issue credentials after exact fresh approval

curl --request POST \
  --url https://api.liftx.io/integrations/credentials \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "request": {
    "name": "<string>",
    "scopes": [],
    "exchange_link_ids": [
      4503599627370496
    ],
    "expires_at": 123,
    "instrument_ids": [
      "<string>"
    ],
    "integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
'

import requests

url = "https://api.liftx.io/integrations/credentials"

payload = {
    "operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "request": {
        "name": "<string>",
        "scopes": [],
        "exchange_link_ids": [4503599627370496],
        "expires_at": 123,
        "instrument_ids": ["<string>"],
        "integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    operation_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    request: {
      name: '<string>',
      scopes: [],
      exchange_link_ids: [4503599627370496],
      expires_at: 123,
      instrument_ids: ['<string>'],
      integration_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    }
  })
};

fetch('https://api.liftx.io/integrations/credentials', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "credential": {
    "id": "77777777-7777-4777-8777-777777777777",
    "integration_id": "88888888-8888-4888-8888-888888888888",
    "name": "Demo controller",
    "kind": "api",
    "prefix": "lx_api_77777777",
    "scopes": [
      "read",
      "positions:open",
      "positions:modify",
      "positions:terminate"
    ],
    "exchange_link_ids": [
      17
    ],
    "instrument_ids": [
      "COPY_EXACT_CATALOG_ID"
    ],
    "created_at": 1893456000,
    "expires_at": 1893542400,
    "revoked_at": null
  }
}

{
  "credential": {
    "id": "77777777-7777-4777-8777-777777777777",
    "integration_id": "88888888-8888-4888-8888-888888888888",
    "name": "Demo controller",
    "kind": "api",
    "prefix": "lx_api_77777777",
    "scopes": [
      "read",
      "positions:open",
      "positions:modify",
      "positions:terminate"
    ],
    "exchange_link_ids": [
      17
    ],
    "instrument_ids": [
      "COPY_EXACT_CATALOG_ID"
    ],
    "created_at": 1893456000,
    "expires_at": 1893542400,
    "revoked_at": null
  },
  "secret": "ONE_TIME_API_SECRET_FROM_AUTHENTICATED_SETTINGS"
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Discovery and account data

Positions and history

Templates

Commands and streams

TradingView webhook

Session-only Settings

Issue an approved credential

Authorization

Behavior

JSON body example

Response and errors

Authorizations

Body

Response

​Authorization

​Behavior

​JSON body example

​Response and errors

Authorizations

Body

Response

Authorization

Behavior

JSON body example

Response and errors