PhoenixPerpetualsDocs API v1
Get an API key

API reference ยท TradingView

GET/v1/tradingview/hooks/{hook_id}

Get a TradingView link⁠.

Read

Path parameters#

  • hook_idstringrequired

    The TradingView link.

Responses#

200OK
  • idstringrequired

    The link.

  • namestringrequired

    Its name.

  • account_idstringrequired

    The account number.

  • environmentstringrequired

    Its environment.

    One oflivesandbox

  • statusstringrequired

    paused: alerts are refused (link_paused).

    One ofactivepaused

  • marketsarray of stringrequired

    The markets it may trade; empty: every market.

  • reduce_onlybooleanrequired

    It may only reduce positions.

  • max_order_usddecimal string or nullrequired

    Its largest order, in USD.

  • max_position_usddecimal string or nullrequired

    Its largest position, in USD.

  • daily_loss_usddecimal string or nullrequired

    Its daily loss stop: no new position once today's loss reaches it.

  • sizingobjectrequired
    Show 2 fields
    • modestringrequired

      from_alert: the size the alert gives. qty, usd, pct_balance: the link's own.

      One offrom_alertqtyusdpct_balance

    • valuedecimal string or nullrequired

      The link's size, in its mode's unit.

  • position_modestringrequired

    signal: an opposite alert reverses, a repeat is skipped. add: a repeat adds. target: the strategy's position size is followed.

    One ofsignaladdtarget

401The request has no Authorization header.
{
  "error": {
    "type": "authentication",
    "code": "missing_api_key",
    "message": "No API key: send it as Authorization: Bearer <key>.",
    "request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
    "retryable": false,
    "doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#missing_api_key"
  }
}
403The key only works from the addresses you listed.
{
  "error": {
    "type": "permission",
    "code": "ip_not_allowed",
    "message": "This address is not on the key's allowlist.",
    "request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
    "retryable": false,
    "doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#ip_not_allowed"
  }
}
404The id is unknown, revoked, or belongs to another customer or environment.
{
  "error": {
    "type": "not_found",
    "code": "tradingview_hook_not_found",
    "message": "No TradingView link with that id.",
    "request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
    "retryable": false,
    "doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#tradingview_hook_not_found"
  }
}
429A request budget is used up (details.scope says which).
{
  "error": {
    "type": "rate_limit",
    "code": "rate_limited",
    "message": "Too many requests: slow down.",
    "request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
    "retryable": true,
    "doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#rate_limited"
  }
}
500An error we did not expect.
{
  "error": {
    "type": "server",
    "code": "internal_error",
    "message": "Something went wrong on our side.",
    "request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
    "retryable": true,
    "doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#internal_error"
  }
}
503The API is starting and has not loaded your keys yet.
{
  "error": {
    "type": "engine",
    "code": "not_ready",
    "message": "The API is starting. Try again in a moment.",
    "request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
    "retryable": true,
    "doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#not_ready"
  }
}

Errors#

Codes this endpoint can return. Match on the code, never on the message.

Guides, endpoints, fields and error codes.