Want to create an iPhone/Android application, or a Facebook widget? Now you can do it with the Myfxbook API. The API allows you to access your account's data programmatically and create your own customized applications.
- A session is non-expiring. In order to expire a session, use the logout method.
- Use 'debug=1' in JSON type for easier development (plain and formatted text).
- Use a secure connection (HTTPS) for maximal security.
- In case of an error, check the 'message' field for the reason.
- Transaction timestamps (open orders/trades, history, data points for daily gain/balance) are in local broker's time zone.
- All response fields are self explanatory. 'Id' is the entity's id, 'accountId' is the account's number.
- Sizing type can be lots or units (OANDA accounts).
- The API allows access to personal information only.
The API consists of the following methods:
Methods | Description | Comments |
---|---|---|
Login | Login to your account. | Creates a new session. |
Logout | Logout from your account. | Invalidates the current session. |
get-my-accounts | Get a list of my accounts and their data. | |
get-watched-accounts | Get a list of my watched accounts. | |
get-open-trades | Get open trades for an account. | |
get-open-orders | Get open orders for an account. | |
get-history | Get history for an account. | History is limited to the last 50 transactions. |
get-daily-gain | Get daily gain values. | Use to create a growth chart. |
get-gain | Get gain value between dates. | |
get-custom-widget | Get a custom widget. | Use to create a custom widget of the balance or growth chart of the account. |
get-community-outlook | Get the community sentiment data. | Free version up to 100 requests per 24 hours. Paid version up to 2880 requests per 24 hours. |
get-community-outlook-by-country | Get the community sentiment by country data. | Must provide symbol name. |
get-data-daily | Get daily data. | Use to create a growth, balance, equity, pips, or profit chart. |
There are several possible error types:
- Required fields missing
- Wrong email/password
- Invalid session
- Invalid account
Since we strive at Myfxbook to keep our service free of any charge, any software you develop should be free. Well designed and properly working applications will be featured in our application area (coming soon).
Please use the Programming section to post any questions regarding the API.
By using the Myfxbook API, you agree to the Terms of use.
Current version of the API is v1.37 (July 19, 2020) - Please check back once in a while for changes and updates.
07/19/20 - get-community-outlook has now two versions - in the free version it is limited to 100 requests per 24 hours while the paid version limit is increased to 2800 requests per 24 hours.
10/04/12 - get-daily-balance method deprecated, added pips to
get-my-accounts, added get-data-daily. Version changed to 1.37
11/27/11 - added profit factor to get-my-accounts method. Version
changed to
1.36
09/21/11 - added currency to get-my-accounts method. Version changed
to 1.35
08/23/11 - added get-gain. Version changed to 1.34
08/07/11 - added profit to Daily Gain . Version changed to 1.33
06/23/11 - added invitationUrl . Version changed to 1.32
05/18/11 - added comment to open orders method and to open trades
method.
Version
changed to
1.31
03/27/11 - added commission to get-my-accounts method. Added
interest and
commission to
get-history method. Version changed to v1.3
11/14/10 - added avgLongPrice/avgShortPrice to get-community-outlook
method.
Version
changed
to
v1.2
11/01/10 - get-community-outlook and get
get-community-outlook-by-country
added.
Version
changed
to v1.1
10/03/10 - firstTradeDate added. Version changed to v1.03
06/27/10 - get-custom-widget added. Version changed to v1.02
05/23/10 - get-watched-accounts added. Version Changed to v1.01
04/11/10 - gmtOffset field deprecated.
Parameter | Description |
---|---|
User email | |
password | User password |
Request:
https://www.myfxbook.com/api/[email protected]&password=letsboogie
Response:
<response error="false" message=""> <session>DSL07vu14QxHWErTIAFrH40></session> </response>
Parameter | Description |
---|---|
session | Session ID |
Request:
https://www.myfxbook.com/api/logout.xml?session=DSL07vu14QxHWErTIAFrH40
Response:
<response error="false" message="Logged out."></response>
Parameter | Description |
---|---|
session | Session ID |
Request:
https://www.myfxbook.com/api/get-my-accounts.xml?session=DSL07vu14QxHWErTIAFrH40
Response:
<response error="false" message=""> <accounts> <account> <id>12345</id> <name>Holy Grail</name> <description> Super duper MA+CCI trading system. </description> <accountId>1013230</accountId> <gain>8.92</gain> <absGain>8.92</absGain> <daily>0.04</daily> <monthly>1.25</monthly> <withdrawals>0.00</withdrawals> <deposits>10000.00</deposits> <interest>11.10</interest> <profit>892.45</profit> <balance>10892.45</balance> <drawdown>53.53</drawdown> <equity>10892.45</equity> <demo>true</demo> <lastUpdateDate>03/01/2010 10:14</lastUpdateDate> <creationDate>08/06/2009 08:13</creationDate> <firstTradeDate>04/21/2008 11:58</firstTradeDate> <tracking>21</tracking> <views>549</views> <commission>0</commission> <currency>USD</currency> <profitFactor>0.16</profitFactor> <pips>81.20</pips> <invitationUrl>https://www.myfxbook.com/members/john101/anyone/347/SDa45X5TSkdIsXg8</invitationUrl> <server> <name>Alpari UK</name> </server> </account> </accounts> </response>
Parameter | Description |
---|---|
session | Session ID |
Request:
https://www.myfxbook.com/api/get-watched-accounts.xml?session=DSL07vu14QxHWErTIAFrH40
Response:
<response error="false" message=""> <accounts> <account> <name>Holy Grail</name> <gain>8.92</gain> <drawdown>53.53</drawdown> <demo>true</demo> <change>1.53</change> </account> </accounts> </response>
Parameter | Description |
---|---|
session | Session ID |
id | Account ID |
Request:
https://www.myfxbook.com/api/get-open-orders.xml?session=DSL07vu14QxHWErTIAFrH40&id=12345
Response:
<response error="false" message=""> <openOrders> <order> <openDate>03/01/2010 13:52</openDate> <symbol>GBPUSD</symbol> <action>Sell Limit</action> <sizing> <type>lots</type> <value>0.08</value> </sizing> <openPrice>1.4932</openPrice> <tp>1.48820</tp> <sl>0.00000</sl> <comment>Best trade ever</comment> </order> </openOrders> </response>
Parameter | Description |
---|---|
session | Session ID |
id | Account ID |
Request:
https://www.myfxbook.com/api/get-open-trades.xml?session=DSL07vu14QxHWErTIAFrH40&id=12345
Response:
<response error="false" message=""> <opentrades> <trade> <openDate>03/01/2010 13:39</openDate> <symbol>GBPUSD</symbol> <action>Sell</action> <sizing> <type>lots</type> <value>0.01</value> </sizing> <openPrice>1.4802</openPrice> <tp>1.4832</tp> <sl>0</sl> <profit>-10.8</profit> <pips>-108.0</pips> <swap>0.0</swap> <comment>Best trade ever</comment> <magic>24129962</magic> </trade> </opentrades> </response>
Parameter | Description |
---|---|
session | Session ID |
id | Account ID |
Request:
https://www.myfxbook.com/api/get-history.xml?session=DSL07vu14QxHWErTIAFrH40&id=12345
Response:
<response error="false" message=""> <history> <transaction> <openDate>03/01/2010 14:13</openDate> <closeDate>03/01/2010 15:26</closeDate> <symbol>GBPUSD</symbol> <action>Buy Limit</action> <sizing> <type>lots</type> <value>0.04</value> </sizing> <openPrice>1.48310</openPrice> <closePrice>1.49340</closePrice> <tp>1.48810</tp> <sl>0.00000</sl> <pips>0.0</pips> <profit>0.00</profit> <comment>Best trade ever</comment> <interest>12.1</interest> <commission>0</commission> </transaction> </history> </response>
Parameter | Description |
---|---|
session | Session ID |
id | Account ID |
start | Start date, format: yyyy-mm-dd |
end | End date, format: yyyy-mm-dd |
Request:
https://www.myfxbook.com/api/get-daily-gain.xml?session=DSL07vu14QxHWErTIAFrH40&id=12345&start=2000-01-01&end=2010-01-01
Response:
<response error="false" message=""> <dailyGain> <gain> <date>02/01/2010</date> <value>0.07</value> <profit>0.03</profit> </gain> </dailyGain> </response>
Parameter | Description |
---|---|
session | Session ID |
id | Account ID |
start | Start date, format: yyyy-mm-dd |
end | End date, format: yyyy-mm-dd |
Request:
https://www.myfxbook.com/api/get-gain.xml?session=DSL07vu14QxHWErTIAFrH40&id=12345&start=2000-01-01&end=2010-01-01
Response:
<response error="false" message=""> <value>86.69</value> </response>
Parameter | Description |
---|---|
session | Session ID |
id | Account ID |
width | Widget width |
height | Widget height |
bgcolor | Background color |
chartbgc | Chart background color |
gridcolor | Grid color |
linecolor | Line color |
barcolor | Bar color |
fontcolor | Font color |
bart | Bar title |
linet | Line title |
charttitle | Chart title |
titles | Title font size |
Request:
https://widgets.myfxbook.com/api/get-custom-widget.png?session=DSL07vu14QxHWErTIAFrH40&id=12345&width=300&height=200&bart=1&linet=0&bgColor=000000&gridColor=BDBDBD&lineColor=00CB05&barColor=FF8D0A&fontColor=FFFFFF&title=&titles=20&chartbgc=474747
Response: (example only)
Parameter | Description |
---|---|
session | Session ID |
*Currency values are represented in USD ($).
Request:
https://www.myfxbook.com/api/get-community-outlook.xml?session=DSL07vu14QxHWErTIAFrH40
Response:
<response error="false" message=""> <community-outlook> <symbols> <symbol> <name>EURUSD</name> <shortPercentage>55</shortPercentage> <longPercentage>44</longPercentage> <shortVolume>1142.58</shortVolume> <longVolume>905.47</longVolume> <longPositions>2932</longPositions> <shortPositions>3888</shortPositions> <totalPositions>2048</totalPositions> <avgShortPrice>1.3808</avgShortPrice> <avgLongPrice>1.4097</avgLongPrice> </symbol> </symbols> <general> <demoAccountsPercentage>43</demoAccountsPercentage> <realAccountsPercentage>56</realAccountsPercentage> <profitablePercentage>54</profitablePercentage> <nonProfitablePercentage>45</nonProfitablePercentage> <fundsWon>6,819,251.63</fundsWon> <fundsLost>-8,740,646.15</fundsLost> <averageDeposit>21,740.16</averageDeposit> <averageAccountProfit>4,127.88</averageAccountProfit> <averageAccountLoss>-5,290.95</averageAccountLoss> <totalFunds>35,914,737.56</totalFunds> </general> </community-outlook> </response>
Parameter | Description |
---|---|
session | Session ID |
symbol | Symbol name |
Request:
https://www.myfxbook.com/api/get-community-outlook-by-country.xml?session=DSL07vu14QxHWErTIAFrH40&symbol=eurusd
Response:
<response error="false" message=""> <community-outlook-by-country> <countries> <country> <name>GERMANY</name> <code>DE</code> <longVolume>13.71</longVolume> <shortVolume>35.76</shortVolume> <longPositions>111</longPositions> <shortPositions>489</shortPositions> </country> </countries> </community-outlook-by-country> </response>
Parameter | Description |
---|---|
session | Session ID |
id | Account ID |
start | Start date, format: yyyy-mm-dd |
end | End date, format: yyyy-mm-dd |
Request:
https://www.myfxbook.com/api/get-data-daily.xml?session=DSL07vu14QxHWErTIAFrH40&id=12345&start=2000-01-01&end=2010-01-01
Response:
<response error="false" message=""> <dataDaily> <data> <date>02/01/2010</date> <balance>25083.56</balance> <pips>83.30</pips> <lots>0.41</lots> <floatingPL>-500.00</floatingPL> <profit>84.7400</profit> <growthEquity>-4.15</growthEquity> <floatingPips>1.00</floatingPips> </data> </dataDaily> </response>
Parameter | Description |
---|---|
User email | |
password | User password |
Request:
https://www.myfxbook.com/api/[email protected]&password=letsboogie
Response:
{ "error": false, "message": "", "session": "DSL07vu4QxHWErTIAFrH40" }
Parameter | Description |
---|---|
session | Session ID |
Request:
https://www.myfxbook.com/api/logout.json?session=DSL07vu14QxHWErTIAFrH40
Response:
{ "error": false, "message": "Logged out." }
Parameter | Description |
---|---|
session | Session ID |
Request:
https://www.myfxbook.com/api/get-my-accounts.json?session=DSL07vu14QxHWErTIAFrH40
Response:
{ "error": false, "message": "", "accounts": [ { "id": 12345, "name": "Holy Grail", "description": "Super duper MA+CCI trading system.", "accountId": 1013230, "gain": 8.92, "absGain": 8.92, "daily": "0.04", "monthly": "1.25", "withdrawals": 0, "deposits": 10000, "interest": 11.1, "profit": 892.45, "balance": 10892.45, "drawdown": 53.53, "equity": 10892.45, "equityPercent": 100, "demo": true, "lastUpdateDate": "03/01/2010 10:14", "creationDate": "08/06/2009 08:13", "firstTradeDate": "04/21/2008 12:18", "tracking": 21, "views": 549, "commission":0, "currency":"USD", "profitFactor": 0.3, "pips": 81.20, "invitationUrl": "https://www.myfxbook.com/members/john101/anyone/347/SDa45X5TSkdIsXg8", "server": { "name": "Alpari UK" } } ] }
Parameter | Description |
---|---|
session | Session ID |
Request:
https://www.myfxbook.com/api/get-watched-accounts.json?session=DSL07vu14QxHWErTIAFrH40
Response:
{ "error": false, "message": "", "accounts": [ { "name": "Holy Grail", "gain": 8.92, "drawdown": 53.53, "demo": true, "change": 1.53, } ] }
Parameter | Description |
---|---|
session | Session ID |
id | Account ID |
Request:
https://www.myfxbook.com/api/get-open-orders.json?session=DSL07vu14QxHWErTIAFrH40&id=12345
Response:
{ "error": false, "message": "", "openOrders": [ { "openTime": "03/01/2010 13:52", "symbol": "GBPUSD", "action": "Sell Limit", "sizing": { "type": "lots", "value": "0.08" }, "openPrice": 1.4932, "tp": 1.4882, "sl": 0, "comment":"Best trade ever" } ] }
Parameter | Description |
---|---|
session | Session ID |
id | Account ID |
Request:
https://www.myfxbook.com/api/get-open-trades.json?session=DSL07vu14QxHWErTIAFrH40&id=12345
Response:
{ "error": false, "message": "", "openTrades": [ { "openTime": "03/01/2010 13:39", "symbol": "GBPUSD", "action": "Sell", "sizing": { "type": "lots", "value": "0.01" }, "openPrice": 1.4802, "tp": 1.4832, "sl": 0, "comment":"best trade ever", "profit": -10.8, "pips": -108, "swap": 0, "magic": 24129962 } ] }
Parameter | Description |
---|---|
session | Session ID |
id | Account ID |
Request:
https://www.myfxbook.com/api/get-history.json?session=DSL07vu14QxHWErTIAFrH40&id=12345
Response:
{ "error": false, "message": "", "history": [ { "openTime": "03/01/2010 14:13", "closeTime": "03/01/2010 15:26", "symbol": "GBPUSD", "action": "Buy Limit", "sizing": { "type": "lots", "value": "0.04" }, "openPrice": 1.4831, "closePrice": 1.4934, "tp": 1.4881, "sl": 0, "comment":"best trade ever", "pips": 0, "profit": 0, "interest": 12.1, "commission": 0 } ] }
Parameter | Description |
---|---|
session | Session ID |
id | Account ID |
start | Start date, format: yyyy-mm-dd |
end | End date, format: yyyy-mm-dd |
Request:
https://www.myfxbook.com/api/get-daily-gain.json?session=DSL07vu14QxHWErTIAFrH40&id=12345&start=2000-01-01&end=2010-01-01
Response:
{ "error": false, "message": "", "dailyGain": [ [ { "date": "02/01/2010", "value": 0.07, "profit": 0.03 }] ] }
Parameter | Description |
---|---|
session | Session ID |
id | Account ID |
start | Start date, format: yyyy-mm-dd |
End | End date, format: yyyy-mm-dd |
Request:
https://www.myfxbook.com/api/get-gain.json?session=DSL07vu14QxHWErTIAFrH40&id=12345&start=2000-01-01&end=2010-01-01
Response:
{ "error": false, "message": "", "value": 86.69 }
Parameter | Description |
---|---|
session | Session ID |
id | Account ID |
width | Widget width |
height | Widget height |
bgcolor | Background color |
chartbgc | Chart background color |
gridcolor | Grid color |
linecolor | Line color |
barcolor | Bar color |
fontcolor | Font color |
bart | Bar title |
linet | Line title |
charttitle | Chart title |
titles | Title font size |
Request:
https://widgets.myfxbook.com/api/get-custom-widget.png?session=DSL07vu14QxHWErTIAFrH40&id=12345&width=300&height=200&bart=1&linet=0&bgColor=000000&gridColor=BDBDBD&lineColor=00CB05&barColor=FF8D0A&fontColor=FFFFFF&title=&titles=20&chartbgc=474747
Response:
Parameter | Description |
---|---|
session | Session ID |
Request:
https://www.myfxbook.com/api/get-community-outlook.json?session=DSL07vu14QxHWErTIAFrH40
Response:
{ "error": false, "message": "", "symbols": [ { "name": "EURUSD", "shortPercentage": 55, "longPercentage": 44, "shortVolume": 1142.58, "longVolume": 905.47, "longPositions": 2932, "shortPositions": 3888, "totalPositions": 2048, "avgShortPrice":1.3808, "avgLongPrice":1.4097 } ], "general": { "demoAccountsPercentage": 43, "realAccountsPercentage": 56, "profitablePercentage": 54, "nonProfitablePercentage": 45, "fundsWon": "6,819,251.63", "fundsLost": "-8,740,646.15", "averageDeposit": "21,740.16", "averageAccountProfit": "4,127.88", "averageAccountLoss": "-5,290.95", "totalFunds": "35,914,737.56" } }
Parameter | Description |
---|---|
session | Session ID |
symbol | Symbol name |
Request:
https://www.myfxbook.com/api/get-community-outlook-by-country.json?session=DSL07vu14QxHWErTIAFrH40&symbol=eurusd
Response:
{ "error": false, "message": "", "countries": [ { "name": "GERMANY", "code": "DE", "longVolume": 13.71, "shortVolume": 35.76, "longPositions": 111, "shortPositions": 489 } ] }
Parameter | Description |
---|---|
session | Session ID |
id | Account ID |
start | Start date, format: yyyy-mm-dd |
end | End date, format: yyyy-mm-dd |
Request:
https://www.myfxbook.com/api/get-data-daily.json?session=DSL07vu14QxHWErTIAFrH40&id=12345&start=2000-01-01&end=2010-01-01
Response:
{ "error": false, "message": "", "dataDaily": [ [ { "date": "02/01/2010", "balance": 25083.56, "pips": 83.30, "lots": 0.41, "floatingPL": -500.00, "profit": 84.7400, "growthEquity": -4.15, "floatingPips": 1.00 }] ] }