API reference

Branding

Read and update how your executor looks to your traders — logo, colours, theme and login screen.

How your executor looks to your traders: the logo, the accent colour, the theme, and the login screen text. Read it to render a matching header in your own dashboard, or write it to change the terminal.

Read branding

GET/v1/brandingPlannedscope · accounts:read
200 OK
{
  "display_name": "Apex Prop",
  "logo_dark_url": "https://storage.googleapis.com/…/logo-dark.svg",
  "logo_light_url": null,
  "favicon_url": "https://storage.googleapis.com/…/favicon.png",
  "accent_color": "#15803d",
  "terminal_theme": "dark",
  "login_headline": "Trade the Apex evaluation",
  "login_subtext": "Sign in with the credentials your account manager sent you.",
  "support_email": "support@apexprop.example",
  "support_url": "https://apexprop.example/help",
  "legal_footer": "Simulated trading. Not a broker.",
  "hide_platform_badge": false
}

Update branding

PUT/v1/brandingPlannedscope · accounts:write

Your tier decides how much of this you can set

minimal allows the display name, dark logo and accent colour. full allows everything except hiding our badge. full_plus allows all of it. A field above your tier is refused with a 400 naming it, rather than being silently dropped.

The public read filters by your current tier, so a field saved under a higher tier stops appearing if your tier drops. It is not deleted — it comes back if you upgrade again.

Uploading a logo or favicon is a separate multipart call; ask if you need it scripted rather than done in the panel.