Trader overrides summary

.md

How many overrides are in force, and how many end this week.

Scopesadmin:read
Permissionview_fraud
GET/v1/admin/fraud/overrides/summary

The two numbers beside the title of Trader overrides on the website: how many overrides are in force, and how many of those end within seven days.

Needs a firm. Our own staff name one with the Propper-Workspace header.

Request

curl "https://api.proppertrading.com/v1/admin/fraud/overrides/summary" \
  -H "Authorization: Bearer ptat_9f2c1a44_3b8e7d2f5c9a1b4e6d8f0a2c4e6b8d1f" \
  -H "Propper-Workspace: acme"

Response

{ "data": { "object": "fraud_override_summary", "active": 4, "ending": 0 }, "meta": { "request_id": "req_01m50zcmb24tm52cyw7xhr7ezf" } }

Errors

StatusCodeMeaning
400workspace_requiredAsked by our own staff without naming a firm
401invalid_tokenNot a token, or the secret does not match
401revoked_tokenSigned out here or from another device
401expired_tokenNinety days without use, or a set expiry passed
403admin_access_requiredThis account no longer helps run the environment
403insufficient_scopeThis device does not hold admin:read
403workspace_not_permittedThe Propper-Workspace header names an environment this account cannot act in
403forbiddenWithout view_fraud