Polyrankdocs
ApiAlerts

GET /v1/notifications

Recent notifications (newest first) + unread count. With alert settings on (ALERT_SETTINGS_ENABLED) each row also carries `kind`, `delivery` and `summary_id`, every alert has a row whatever its delivery, and the unread count counts only rows delivered one by one and summaries.

GET
/v1/notifications

Recent notifications (newest first) + unread count. With alert settings on (ALERT_SETTINGS_ENABLED) each row also carries kind, delivery and summary_id, every alert has a row whatever its delivery, and the unread count counts only rows delivered one by one and summaries.

Authorization

AuthorizationBearer <token>

API key: Authorization: Bearer pk_live_… (mint at polyrank.app/api-keys)

In: header

Query Parameters

limit?integer

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/notifications"
{  "notifications": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "type": "string",      "title": "string",      "body": "string",      "data": {        "property1": null,        "property2": null      },      "read_at": "string",      "created_at": "string",      "kind": "trader_fill",      "delivery": "instant",      "summary_id": "781665b4-ecf6-4d1d-9512-816df8a05da6"    }  ],  "unread_count": -9007199254740991}
{  "error": "string",  "message": "string",  "feature": "string",  "field": "string",  "plan": "string",  "retry_after_sec": 0,  "retry_after_seconds": 0,  "reason": "string",  "issues": [    null  ],  "trace_id": "string"}
{  "error": "string",  "message": "string",  "feature": "string",  "field": "string",  "plan": "string",  "retry_after_sec": 0,  "retry_after_seconds": 0,  "reason": "string",  "issues": [    null  ],  "trace_id": "string"}
{  "error": "string",  "message": "string",  "feature": "string",  "field": "string",  "plan": "string",  "retry_after_sec": 0,  "retry_after_seconds": 0,  "reason": "string",  "issues": [    null  ],  "trace_id": "string"}
{  "error": "string",  "message": "string",  "feature": "string",  "field": "string",  "plan": "string",  "retry_after_sec": 0,  "retry_after_seconds": 0,  "reason": "string",  "issues": [    null  ],  "trace_id": "string"}
{  "error": "string",  "message": "string",  "feature": "string",  "field": "string",  "plan": "string",  "retry_after_sec": 0,  "retry_after_seconds": 0,  "reason": "string",  "issues": [    null  ],  "trace_id": "string"}
{  "error": "string",  "message": "string",  "feature": "string",  "field": "string",  "plan": "string",  "retry_after_sec": 0,  "retry_after_seconds": 0,  "reason": "string",  "issues": [    null  ],  "trace_id": "string"}
{  "error": "string",  "message": "string",  "feature": "string",  "field": "string",  "plan": "string",  "retry_after_sec": 0,  "retry_after_seconds": 0,  "reason": "string",  "issues": [    null  ],  "trace_id": "string"}