Broker API HubMenu

MT5 Python copy_rates_from_pos()

functioncopy_rates_from_pos()MetaTrader5 Python packageBars and ticks

Returns a number of bars for one instrument and timeframe, starting from a bar index where 0 is the bar now forming.

Risk warning: CFDs and spread bets are complex instruments and come with a high risk of losing money rapidly due to leverage. You can lose money on these products, and each provider publishes its own loss figure under FCA rules. You should consider whether you understand how they work and whether you can afford to take the high risk of losing your money. Automated and API trading can amplify losses through bugs, connectivity failures and runaway orders.

Independent and unofficialmql5.comchecked

This is a Python function, not an HTTP endpoint. It has no method, no path and no address to send a request to: the package talks to a MetaTrader 5 terminal running on the same computer.

The page says the terminal supplies bars only as far back as its charts hold, a limit set by the terminal's Max. bars in chart setting.

Signature

The form of the call on the vendor's page, with the vendor's comments taken out.

copy_rates_from_pos(
  symbol,
  timeframe,
  start_pos,
  count
)

Arguments

NameTypeDescription
symbolrequiredNot statedThe instrument's name. The page's example value is "EURUSD".
timeframerequiredNot statedThe bar size, as a value of the package's TIMEFRAME enumeration.
start_posrequiredNot statedThe index of the first bar wanted. Bars are numbered from the present into the past, so 0 is the current bar.
countrequiredNot statedHow many bars to return.

Return value

Type
numpy array or None
What comes back
One row per bar with the named columns time, open, high, low, close, tick_volume, spread and real_volume. On failure the page says it returns None, and that last_error() gives the reason.

Sample

Written by this site from the signature and arguments recorded on this page. It has not been run against a terminal, a server or an account, and the values in it are placeholders. No credential is typed into it: where one is needed it is read from an environment variable on your own machine. Nothing is entered on this site.

import MetaTrader5 as mt5

if not mt5.initialize():
    raise SystemExit(f"initialize() failed: {mt5.last_error()}")

# The ten most recent daily bars, the current one first in the count.
rates = mt5.copy_rates_from_pos("EURUSD", mt5.TIMEFRAME_D1, 0, 10)
if rates is not None:
    print(rates["close"])

mt5.shutdown()