API reference ยท TradingView
POST
/v1/tradingview/parseRead an alert message.
Read
How an alert message would be read, sent nowhere: the action, sizes, prices, exits and market, and with a link what it would do now.
Request body#
-
The alert's message, as TradingView would send it.
-
hook_idstringA link: the plan is then worked out on its account and settings, as of now.
Responses#
200OK
-
It reads, and names a market we offer.
-
Why not, when it does not.
-
The field at fault.
-
What went wrong.
-
The message as read: action, side, sizes, prices, exits.
-
The market it names (ALL for every market).
-
The market meant, when the ticker names one we offer only scaled.
-
With hook_id: what the alert would do now ({ legs } / { skip } / { refuse }).
400The request is malformed.
{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "The request is not valid.",
"request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
"retryable": false,
"doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#invalid_request"
}
}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.