orders_get

Obtém ordens ativas com a capacidade de filtrar por símbolo ou bilhete. Existem 3 variantes de chamada.

Chamada sem parâmetros. Retorna as ordens ativas de todos os símbolos.

orders_get()

Uma chamada indicando o símbolo pelo qual é necessário receber as ordens ativas.

orders_get(
   symbol="SYMBOL"      // nome do símbolo
)

Uma chamada indicando o grupo de símbolos para o qual é necessário receber ordens ativas.

orders_get(
   group="GROUP"        // filtro para selecionar ordens por símbolos
)

Uma chamada indicando o bilhete da ordem.

orders_get(
   ticket=TICKET        // bilhete
)

symbol="SYMBOL"

[in]  Nome do símbolo. Parâmetro nomeado opcional. Se o símbolo for especificado, o parâmetro ticket será ignorado.

group="GROUP"

[in]  Filtro para selecionar apenas o grupo de símbolos necessários. Parâmetro nomeado opcional. Se um grupo for especificado, a função retornará apenas as ordens que satisfazem os critérios especificados para o nome do símbolo.

ticket=TICKET

[in]  Bilhete da ordem (ORDER_TICKET). Parâmetro nomeado opcional.

Valor retornado

Retorna informações na forma de uma estrutura de tuplas nomeadas (namedtuple). Em caso de erro, retorna None, enquanto informações sobre o erro podem ser obtidas usando last_error().

Observação

A função permite de uma chamada receber todas as ordens ativas, a ligação OrdersTotal e OrderSelect é um análogo.

O parâmetro group permite filtrar ordens por símbolos, é permitido usar '*' no início e no final da linha.

O parâmetro group pode conter várias condições, separadas por vírgulas. A condição pode ser especificada como uma máscara usando '*'. Para exclusões, pode-se usar o símbolo de negação lógica '!'. Neste caso, todas as condições são aplicadas sequencialmente, ou seja, primeiro deve-se especificar as condições para inclusão no grupo e, em seguida, a condição de exclusão. Por exemplo, group="*, !EUR" significa que primeiro é necessário selecionar as ordens de todos os símbolos e, em seguida, excluir as que contêm o símbolo "EUR" no nome.

Exemplo:

import MetaTrader5 as mt5
import pandas as pd
pd.set_option('display.max_columns'500# número de colunas mostradas
pd.set_option('display.width', 1500)      # max. largura máxima da tabela exibida
# exibimos dados sobre o pacote MetaTrader5
print("MetaTrader5 package author: ",mt5.__author__)
print("MetaTrader5 package version: ",mt5.__version__)
print()
# estabelecemos a conexão ao MetaTrader 5
if not mt5.initialize():
    print("initialize() failed, error code =",mt5.last_error())
    quit()
 
# exibimos informações sobre ordens ativas do símbolo GBPUSD
orders=mt5.orders_get(symbol="GBPUSD")
if orders is None:
    print("No orders on GBPUSD, error code={}".format(mt5.last_error()))
else:
    print("Total orders on GBPUSD:",len(orders))
    # exibimos todas as ordens ativas
    for order in orders:
        print(order)
print()
 
# obtemos uma lista de ordens com base em símbolos cujos nomes contenham "*GBP*"
gbp_orders=mt5.orders_get(group="*GBP*")
if gbp_orders is None:
    print("No orders with group=\"*GBP*\", error code={}".format(mt5.last_error()))
else:
    print("orders_get(group=\"*GBP*\")={}".format(len(gbp_orders)))
    # exibimos essas posições como uma tabela usando pandas.DataFrame
    df=pd.DataFrame(list(gbp_orders),columns=gbp_orders[0]._asdict().keys())
    df.drop(['time_done', 'time_done_msc', 'position_id', 'position_by_id', 'reason', 'volume_initial', 'price_stoplimit'], axis=1, inplace=True)
    df['time_setup'] = pd.to_datetime(df['time_setup'], unit='s')
    print(df)
 
# concluímos a conexão ao terminal MetaTrader 5
mt5.shutdown()
 
Resultado:
MetaTrader5 package author:  MetaQuotes Software Corp.
MetaTrader5 package version:  5.0.29
 
Total orders on GBPUSD: 2
TradeOrder(ticket=554733548, time_setup=1585153667, time_setup_msc=1585153667718, time_done=0, time_done_msc=0, time_expiration=0, type=3, type_time=0, ...
TradeOrder(ticket=554733621, time_setup=1585153671, time_setup_msc=1585153671419, time_done=0, time_done_msc=0, time_expiration=0, type=2, type_time=0, ...
 
orders_get(group="*GBP*")=4
      ticket          time_setup  time_setup_msc  time_expiration  type  type_time  type_filling  state  magic  volume_current  price_open   sl   tp  price_current  symbol comment external_id
0  554733548 2020-03-25 16:27:47   1585153667718                0     3          0             2      1      0             0.2     1.25379  0.0  0.0        1.16803  GBPUSD                    
1  554733621 2020-03-25 16:27:51   1585153671419                0     2          0             2      1      0             0.2     1.14370  0.0  0.0        1.16815  GBPUSD                    
2  554746664 2020-03-25 16:38:14   1585154294401                0     3          0             2      1      0             0.2     0.93851  0.0  0.0        0.92428  EURGBP                    
3  554746710 2020-03-25 16:38:17   1585154297022                0     2          0             2      1      0             0.2     0.90527  0.0  0.0        0.92449  EURGBP    

Veja também

orders_total, positions_get