TraderMemos

Share links

GET/api/v1/share-links

All endpoints under this tag 404 unless TM_SHARE_LINKS_ENABLED=true.

Authorization

bearerAuth
AuthorizationBearer <token>

Session JWT access token or personal access token (tm_pat_…).

In: header

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/share-links"
[  {    "id": "string",    "token": "string",    "scope": {      "account_id": "string",      "from": "2019-08-24T14:15:22Z",      "to": "2019-08-24T14:15:22Z",      "tz": "string",      "show_amounts": true,      "currency": "string"    },    "created_at": "2019-08-24T14:15:22Z",    "expires_at": "2019-08-24T14:15:22Z",    "view_count": 0  }]
POST/api/v1/share-links

Mints a revocable public link for a read-only performance summary. Omit expires_in_days for the 90-day default; 0 means never expires. With show_amounts false (the default) the public payload carries ratios and shape only — no absolute money amounts.

Authorization

bearerAuth
AuthorizationBearer <token>

Session JWT access token or personal access token (tm_pat_…).

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/share-links" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "token": "string",  "scope": {    "account_id": "string",    "from": "2019-08-24T14:15:22Z",    "to": "2019-08-24T14:15:22Z",    "tz": "string",    "show_amounts": true,    "currency": "string"  },  "created_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "view_count": 0}
DELETE/api/v1/share-links/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

Session JWT access token or personal access token (tm_pat_…).

In: header

Path Parameters

id*string

Response Body

application/json

application/json

curl -X DELETE "https://example.com/api/v1/share-links/string"
Empty

Public share summary

GET/api/v1/public/share/{token}

The page behind a share link. Unauthenticated by design and rate-limited. Disabled, unknown, revoked, and expired links all answer the same 404. The payload is a dedicated aggregate (never trade rows or account names); money fields appear only when the link allows amounts.

Path Parameters

token*string

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/public/share/string"
{  "summary": {},  "equity": [    {      "at": "2019-08-24T14:15:22Z",      "value": 0    }  ],  "months": [    {}  ],  "top_symbols": [    {}  ],  "trading_days": 0,  "green_days": 0,  "red_days": 0,  "best_streak": 0,  "worst_streak": 0,  "first_day": "string",  "last_day": "string",  "show_amounts": true,  "currency": "string"}