{"id":3962,"date":"2023-06-30T12:47:50","date_gmt":"2023-06-30T10:47:50","guid":{"rendered":"https:\/\/cplugin.com\/?post_type=docs&#038;p=3962"},"modified":"2026-04-01T12:58:40","modified_gmt":"2026-04-01T10:58:40","password":"","slug":"restful","status":"publish","type":"docs","link":"https:\/\/cplugin.com\/docs\/webapi\/restful\/","title":{"rendered":"RESTful"},"content":{"rendered":"\n<h2 class=\"wp-block-heading\" id=\"RESTful-Brief\">Brief<\/h2>\n\n\n\n<p>This is a standard RESTful JSON WebAPI.<\/p>\n\n\n\n<p>Before making any calls to WebAPI you need to be authenticated.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"RESTful-Authentication\">Authentication<\/h2>\n\n\n\n<p>Once you get authorized you shall pass token within each call inside HTTP headers.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code class=\"\">Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjE0M2U4MjljMmI1NzQ4OTk2OTc1M2JhNGY4MjA1OTc5ZGYwZGE5ODh......&lt;truncated for clarity>\r<\/code><\/pre>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"RESTful-TradePlatform\">TradePlatform<\/h2>\n\n\n\n<p>To understand with what MT4\/MT5 server you are going to work we have unique identifier assigned to each trade platform you registered at Admin portal&nbsp;\u2192 Trade platforms (<a href=\"https:\/\/admin.cplugin.net\/TradePlatforms\" class=\"broken_link\" rel=\"nofollow\">https:\/\/admin.cplugin.net\/TradePlatforms<\/a>). There you choose type of this trade platform: MT4, MT5, etc. So, WebAPI will use right MetaQuotes Manager API.<\/p>\n\n\n\n<p>Each trade platform has unique ID.<br>Controllers might require you to pass this\u00a0<em>TradePlatformID<\/em>\u00a0which can be obtained once (and saved locally to save time).<br>To get a list of all trade platforms available for you with its identifiers request this list\u00a0using method:\u00a0<a href=\"https:\/\/cloud.mywebapi.com\/swagger\/ui\/index#!\/TradePlatforms\/TradePlatforms_Get\" class=\"broken_link\" rel=\"nofollow\">https:\/\/cloud.mywebapi.com\/swagger\/ui\/index#!\/TradePlatforms\/TradePlatforms_Get<br><\/a>So, get it and pass it where is supposed to be as additional URL encoded parameter like in example:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code class=\"\">GET \/api\/MT4\/{tradePlatform}\/UserRecordGet\/{login}<\/code><\/pre>\n\n\n\n<p>Replace {tradePlatform} and {login} with real identifiers.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Powershell Example<\/h2>\n\n\n\n<pre class=\"wp-block-code\"><code lang=\"powershell\" class=\"language-powershell\"># Flows :: ClientCredentials\r\n \r\n$VerbosePreference = [System.Management.Automation.ActionPreference]::Continue\r\n \r\n$ass = [Reflection.Assembly]::LoadFile(\"\\packages\\Newtonsoft.Json.6.0.8\\lib\\net45\\Newtonsoft.Json.dll\")\r\n$ass = [Reflection.Assembly]::LoadWithPartialName(\"System.Net.Http\")\r\n$ass = [Reflection.Assembly]::LoadWithPartialName(\"System.IdentityModel\")\r\n$ass = [Reflection.Assembly]::LoadFile(\"\\packages\\IdentityModel.1.3.1\\lib\\net45\\IdentityModel.Net45.dll\")\r\n \r\n$IdSrvURI = \"https:\/\/auth.cplugin.net\"\r\n$apiURI = \"https:\/\/cloud.mywebapi.com\"\r\n \r\n$clientId=\"&lt;put your client id here>\"\r\n$clientSecret=\"&lt;put your client secret here>\"\r\n \r\n#orgs:\r\n$org_cplugin = \"&lt;put your organization id here>\"\r\n \r\n#mt4:\r\n$tp = \"&lt;put your trade platform id here>\"\r\n \r\n'==> authenticating...' | Write-Host -BackgroundColor Black\r\n$client = new-object IdentityModel.Client.TokenClient `\r\n    (($IdSrvURI+\"\/connect\/token\"), $clientId, $clientSecret, [IdentityModel.Client.AuthenticationStyle]::BasicAuthentication)\r\n#$client | Format-List\r\n \r\n$ct = new-object System.Threading.CancellationToken\r\n$authResult = [IdentityModel.Client.TokenClientExtensions]::RequestClientCredentialsAsync(`\r\n    $client, \"webapi\", $null, $ct).Result\r\n'==> done!' | Write-Host -BackgroundColor Black\r\n \r\n\"authResult:\" | Write-Host -BackgroundColor Black\r\n$authResult | Format-List\r\n \r\n$auth_headers = @{\r\n    \"Authorization\" = \"Bearer \" + $authResult.AccessToken\r\n}\r\n \r\nfunction rest_get($url)\r\n{\r\n    #$url | Write-Host -BackgroundColor Black\r\n    Invoke-RestMethod -Uri ($apiURI + $url)  -ContentType \"application\/json\" -Headers $auth_headers -Verbose -MaximumRedirection 0\r\n    ($url + \" done\") | Write-Verbose\r\n}\r\n \r\nfunction rest_get_single($url)\r\n{\r\n    \"Result: \" + (rest_get $url)\r\n}\r\n \r\nfunction rest_get_list($url)\r\n{\r\n    (rest_get $url).value | Format-List\r\n}\r\n \r\nfunction rest_get_table($url)\r\n{\r\n    (rest_get $url).value | Format-Table\r\n}\r\n \r\nfunction rest_put($url, $data = $null)\r\n{\r\n    #$url | Write-Host -BackgroundColor Black\r\n    Invoke-RestMethod -Method Put -Uri ($apiURI + $url)  -ContentType \"application\/json\" -Headers $auth_headers -Verbose -MaximumRedirection 0 | Format-List\r\n    ($url + \" done\") | Write-Verbose\r\n}\r\n \r\nfunction rest_post($url, $data = $null)\r\n{\r\n    #$url | Write-Host -BackgroundColor Black\r\n    Invoke-RestMethod -Method Post -Uri ($apiURI + $url)  -ContentType \"application\/json\" -Headers $auth_headers -Verbose -MaximumRedirection 0 | Format-List\r\n    ($url + \" done\") | Write-Verbose\r\n}\r\n \r\nrest_get_list \"\/API\/Organizations\"\r\nrest_get_list \"\/API\/TradePlatforms\"\r\nrest_get_list \"\/API\/MT4\/$tp\/UsersGet\"<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\">Balance transaction example<\/h3>\n\n\n\n<p><a href=\"https:\/\/cloud.mywebapi.com\/swagger\/index.html#\/MT4\/MT4_TradeTransaction\">https:\/\/cloud.mywebapi.com\/swagger\/index.html#\/MT4\/MT4_TradeTransaction<\/a><\/p>\n\n\n\n<p><em>TradeTransInfo<\/em>&nbsp;can be partially specified with only fields below:<\/p>\n\n\n\n<p>tradeTransactionType =&nbsp;BrBalance<br>tradeCommand =&nbsp;Balance<br>orderBy = account login<br>price = amount to be deposited\/withdrawn<\/p>\n\n\n\n<p><strong>PowerShell example<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code lang=\"powershell\" class=\"language-powershell\">rest_post -url \"\/api\/MT4\/$your_tradeplatform\/TradeTransaction\" -data \"{'tradeTransactionType':'BrBalance', 'tradeCommand':'Balance', 'orderBy':1000, 'price':100}\"<\/code><\/pre>\n\n\n\n<h5 class=\"wp-block-heading\" id=\"MT4functions-Howtocreatenewtradeaccount?\">How to create new trade account?<\/h5>\n\n\n\n<p><a href=\"https:\/\/cloud.mywebapi.com\/swagger\/index.html#\/MT4\/MT4_UserRecordNew\">https:\/\/cloud.mywebapi.com\/swagger\/index.html#\/MT4\/MT4_UserRecordNew<\/a><\/p>\n\n\n\n<p><em>UserRecord<\/em>&nbsp;an be partially specified with only fields below:<\/p>\n\n\n\n<p>group<br>name<\/p>\n\n\n\n<p>rest fields MT4 will fill\/generate for you in response<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Brief This is a standard RESTful JSON WebAPI. Before making any calls to WebAPI you need to be authenticated. Authentication Once you get authorized you shall pass token within each call inside HTTP headers. TradePlatform To understand with what MT4\/MT5 server you are going to work we have unique identifier assigned to each trade platform [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"site-sidebar-layout":"default","site-content-layout":"","ast-site-content-layout":"default","site-content-style":"default","site-sidebar-style":"default","ast-global-header-display":"","ast-banner-title-visibility":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","theme-transparent-header-meta":"","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","astra-migrate-meta-layouts":"set","ast-page-background-enabled":"default","ast-page-background-meta":{"desktop":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"ast-content-background-meta":{"desktop":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"footnotes":""},"doc_category":[96],"doc_tag":[],"class_list":["post-3962","docs","type-docs","status-publish","hentry","doc_category-webapi"],"year_month":"2026-06","word_count":551,"total_views":0,"reactions":{"happy":0,"normal":0,"sad":0},"author_info":{"name":"Vladislav Sorokin","author_nicename":"cplugin","author_url":"https:\/\/cplugin.com\/blog\/author\/cplugin\/"},"doc_category_info":[{"term_name":"WebAPI","term_url":"https:\/\/cplugin.com\/docs-category\/webapi\/"}],"doc_tag_info":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v25.7 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>RESTful API \u2013 Cplugin Seamless Integration &amp; Automation<\/title>\n<meta name=\"description\" content=\"Explore Cplugin RESTful API for seamless trading platform integration. Enable real-time data access, automated trading, and management of MT4\/MT5 operations.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/cplugin.com\/docs\/webapi\/restful\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"RESTful API \u2013 Cplugin Seamless Integration &amp; Automation\" \/>\n<meta property=\"og:description\" content=\"Explore Cplugin RESTful API for seamless trading platform integration. Enable real-time data access, automated trading, and management of MT4\/MT5 operations.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/cplugin.com\/docs\/webapi\/restful\/\" \/>\n<meta property=\"og:site_name\" content=\"CPlugin\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/cplugin\" \/>\n<meta property=\"article:modified_time\" content=\"2026-04-01T10:58:40+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:site\" content=\"@CPlugin_com\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"1 minute\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/cplugin.com\/docs\/webapi\/restful\/\",\"url\":\"https:\/\/cplugin.com\/docs\/webapi\/restful\/\",\"name\":\"RESTful API \u2013 Cplugin Seamless Integration & Automation\",\"isPartOf\":{\"@id\":\"https:\/\/cplugin.com\/#website\"},\"datePublished\":\"2023-06-30T10:47:50+00:00\",\"dateModified\":\"2026-04-01T10:58:40+00:00\",\"description\":\"Explore Cplugin RESTful API for seamless trading platform integration. Enable real-time data access, automated trading, and management of MT4\/MT5 operations.\",\"breadcrumb\":{\"@id\":\"https:\/\/cplugin.com\/docs\/webapi\/restful\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/cplugin.com\/docs\/webapi\/restful\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/cplugin.com\/docs\/webapi\/restful\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/cplugin.com\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Docs\",\"item\":\"https:\/\/cplugin.com\/wiki\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"RESTful\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/cplugin.com\/#website\",\"url\":\"https:\/\/cplugin.com\/\",\"name\":\"CPlugin\",\"description\":\"CPlugin offers software and services to Forex brokers who use MetaQuotes MetaTrader 4 and 5 which are most advanced and reliable trading platforms.\",\"publisher\":{\"@id\":\"https:\/\/cplugin.com\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/cplugin.com\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/cplugin.com\/#organization\",\"name\":\"CPlugin Ltd.\",\"url\":\"https:\/\/cplugin.com\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/cplugin.com\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/www.cplugin.com\/wp-content\/uploads\/2021\/07\/CPlugin-logo-1.png\",\"contentUrl\":\"https:\/\/www.cplugin.com\/wp-content\/uploads\/2021\/07\/CPlugin-logo-1.png\",\"width\":1823,\"height\":677,\"caption\":\"CPlugin Ltd.\"},\"image\":{\"@id\":\"https:\/\/cplugin.com\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.facebook.com\/cplugin\",\"https:\/\/x.com\/CPlugin_com\",\"https:\/\/www.linkedin.com\/company\/cplugin\",\"https:\/\/www.youtube.com\/c\/CPlugin_com\"]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"RESTful API \u2013 Cplugin Seamless Integration & Automation","description":"Explore Cplugin RESTful API for seamless trading platform integration. Enable real-time data access, automated trading, and management of MT4\/MT5 operations.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/cplugin.com\/docs\/webapi\/restful\/","og_locale":"en_US","og_type":"article","og_title":"RESTful API \u2013 Cplugin Seamless Integration & Automation","og_description":"Explore Cplugin RESTful API for seamless trading platform integration. Enable real-time data access, automated trading, and management of MT4\/MT5 operations.","og_url":"https:\/\/cplugin.com\/docs\/webapi\/restful\/","og_site_name":"CPlugin","article_publisher":"https:\/\/www.facebook.com\/cplugin","article_modified_time":"2026-04-01T10:58:40+00:00","twitter_card":"summary_large_image","twitter_site":"@CPlugin_com","twitter_misc":{"Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/cplugin.com\/docs\/webapi\/restful\/","url":"https:\/\/cplugin.com\/docs\/webapi\/restful\/","name":"RESTful API \u2013 Cplugin Seamless Integration & Automation","isPartOf":{"@id":"https:\/\/cplugin.com\/#website"},"datePublished":"2023-06-30T10:47:50+00:00","dateModified":"2026-04-01T10:58:40+00:00","description":"Explore Cplugin RESTful API for seamless trading platform integration. Enable real-time data access, automated trading, and management of MT4\/MT5 operations.","breadcrumb":{"@id":"https:\/\/cplugin.com\/docs\/webapi\/restful\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/cplugin.com\/docs\/webapi\/restful\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/cplugin.com\/docs\/webapi\/restful\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/cplugin.com\/"},{"@type":"ListItem","position":2,"name":"Docs","item":"https:\/\/cplugin.com\/wiki\/"},{"@type":"ListItem","position":3,"name":"RESTful"}]},{"@type":"WebSite","@id":"https:\/\/cplugin.com\/#website","url":"https:\/\/cplugin.com\/","name":"CPlugin","description":"CPlugin offers software and services to Forex brokers who use MetaQuotes MetaTrader 4 and 5 which are most advanced and reliable trading platforms.","publisher":{"@id":"https:\/\/cplugin.com\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/cplugin.com\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/cplugin.com\/#organization","name":"CPlugin Ltd.","url":"https:\/\/cplugin.com\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/cplugin.com\/#\/schema\/logo\/image\/","url":"https:\/\/www.cplugin.com\/wp-content\/uploads\/2021\/07\/CPlugin-logo-1.png","contentUrl":"https:\/\/www.cplugin.com\/wp-content\/uploads\/2021\/07\/CPlugin-logo-1.png","width":1823,"height":677,"caption":"CPlugin Ltd."},"image":{"@id":"https:\/\/cplugin.com\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/cplugin","https:\/\/x.com\/CPlugin_com","https:\/\/www.linkedin.com\/company\/cplugin","https:\/\/www.youtube.com\/c\/CPlugin_com"]}]}},"_links":{"self":[{"href":"https:\/\/cplugin.com\/wp-json\/wp\/v2\/docs\/3962","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/cplugin.com\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/cplugin.com\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/cplugin.com\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/cplugin.com\/wp-json\/wp\/v2\/comments?post=3962"}],"version-history":[{"count":2,"href":"https:\/\/cplugin.com\/wp-json\/wp\/v2\/docs\/3962\/revisions"}],"predecessor-version":[{"id":4318,"href":"https:\/\/cplugin.com\/wp-json\/wp\/v2\/docs\/3962\/revisions\/4318"}],"wp:attachment":[{"href":"https:\/\/cplugin.com\/wp-json\/wp\/v2\/media?parent=3962"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/cplugin.com\/wp-json\/wp\/v2\/doc_category?post=3962"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/cplugin.com\/wp-json\/wp\/v2\/doc_tag?post=3962"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}