Skip to main content

Get account routes

    -X GET
--header 'Authorization: Bearer {token here}'
'https://api.lime.co/accounts/{account_number}/routes'

Response example

[
{
"exchange": "Zero Commission",
"time_in_force": [ "day" ],
"order_type": [ "market", "limit" ]
},
{
"exchange": "Extended hours",
"time_in_force": [ "ext" ],
"order_type": [ "limit" ]
},
{
"exchange": "XNAS - Nasdaq",
"time_in_force": [ "day", "ext" ],
"order_type": [ "market", "limit" ]
},
{
"exchange": "XNYS - NYSE",
"time_in_force": [ "day" ],
"order_type": [ "market", "limit" ]
},
{
"exchange": "ARCA - NYSE Arca",
"time_in_force": [ "day", "ext" ],
"order_type": [ "limit" ]
},
{
"exchange": "BATS - BZX Exchange",
"time_in_force": [ "day", "ext" ],
"order_type": [ "limit" ]
},
{
"exchange": "BATY - BYX Exchange",
"time_in_force": [ "day", "ext" ],
"order_type": [ "limit" ]
},
{
"exchange": "EDGA - EDGA Exchange",
"time_in_force": [ "day", "ext" ],
"order_type": [ "limit" ]
},
{
"exchange": "EDGX - EDGX Exchange",
"time_in_force": [ "day", "ext" ],
"order_type": [ "limit" ]
}
]

Returns a list of all routes available for specified account.

Request

parameterdescription
account_numberRequired. The account number

Response

nametypedescription
exchangestringRoute name to use in Place an order method
time_in_forcearrayList of order duration instructions supported by a route. Possible values are day - regular hours, ext - extended hours, on-open - opening auction, on-close - closing auction, ioc - immediate or cancel, fok - fill or kill
order_typearrayList of order types supported by a route. Possible values are limit, market