Skip to main content
GET
Retrieve an application

Authorizations

Authorization
string
header
required

Authorization: Bearer <key>. Sandbox keys start with mgw_test_ and live keys start with mgw_live_. Each key works only in its own environment, and a live key works only from the IP addresses or ranges registered for it.

Path Parameters

id
string
required

The application's id.

Response

An application.

object
string
required
Allowed value: "application"
id
string
required

Unique identifier for the application. Starts with app_.

state
enum<string>
required

sending: stored, and the send is in progress. submitted: the broker accepted it. opened: account is the new account, and you can trade for it. uncertain: we don't know whether the broker received it. We don't send it again; we reconcile it with the broker. rejected: see reject_reason and param. refused: it never reached the broker. unplaced: we found that the broker never had it.

Available options:
sending,
submitted,
opened,
uncertain,
rejected,
refused,
unplaced
reference
string | null
required

The broker's reference for the application, once the broker has accepted it.

account
string | null
required

The account code, once the account is opened.

reason
string | null
required

A sentence explaining the application's current state. It's for people to read, so don't use it in your logic.

reject_reason
enum<string> | null
required

Why the application was rejected. Set only when state is rejected.

Available options:
invalid_field,
already_at_broker,
rejected_by_broker,
declined_by_broker,
null
param
string | null
required

The field that caused the rejection, when the rejection names one. Never includes the field's value.

created_at
string<date-time>
required
updated_at
string<date-time>
required