LogoLogo
Release notesHomepageTry demo
  • Welcome to the B2COPY knowledge base
  • Admin guide
    • Sign-in and 2FA
    • General interface overview
    • Configure B2COPY
      • Configure copy-trading and MAM settings
      • Configure PAMM settings
      • Configure Web UI settings
        • Show on Leaderboard
        • Show on Statistics page
        • Show on Trading Report
        • Fee settings
        • Subscription settings
        • Risk Ratio settings (applicable for copy trading only)
        • Account Properties
      • Configure account settings
        • Account settings
        • Default Master’s Positions Visibility
        • Default Investor’s Positions Visibility (applicable for PAMM only)
      • Configure access settings (only for a standalone solution)
      • Configure deposit and withdrawal settings (only for a standalone solution)
      • Configure the performance fee calculation settings
      • Configure the management fee calculation settings
      • Configure symbol mapping
      • Configure the trade fee filter
      • Configure B2COPY widgets
      • Prevent syncing of collapsed MetaTrader trading history with B2COPY
      • Copy positions to investment accounts with master account prices
      • Link open positions
      • Enable clients to select account groups when creating master and investment accounts in the Web UI
      • Run the Introducing Brokers (IB) program
        • Manage IB levels
        • Customize the IB partnership settings of investment accounts
      • Allocate custom rewards for assistance in managing master accounts
      • Use email templates to notify clients about important events
    • Register new Back Office users
      • Disable 2FA for Back Office users
    • Register new clients
      • Register new clients with email addresses
      • Register new clients with MT account logins (only for a standalone solution)
      • Add a profile picture and nickname to a client profile
    • Manage master and investment accounts
      • Create a master account
      • Set the default allocation parameters for a copy-trading or MAM master account
      • Set the allocation method and rollover settings for a PAMM master account
      • Create fee plans for a master account
      • Modify the default fee plan for a master account
      • Assign risk limits to a master account
      • Determine if risk limits are assigned to a master account
      • Assign a minimum deposit to a master account
      • Assign a subscription code to a master account
      • Set up a promo offer for a master account
      • View and execute pending PAMM requests on master accounts
      • Cancel pending PAMM requests on investment accounts
      • Create an investment account
      • Archive master and investment accounts
      • View information about archived accounts
      • Restore archived accounts
    • Manage trading robots
    • Manage subscriptions
      • Create a copy-trading or MAM subscription
      • Create a PAMM subscription
      • Assign a risk limit to a subscription
      • Modify a subscription
      • Resync open positions on a master account with subscribed investment accounts
      • Change a fee plan for an existing subscription
      • Initialize instant fee payments for subscriptions
      • View details about fees paid for a subscription
      • Pause and resume subscriptions
      • Terminate or reactivate a subscription
    • Manage deposits and withdrawals
      • Deposit funds to copy-trading and MAM accounts
      • Withdraw funds from copy-trading and MAM accounts
      • Deposit funds to PAMM accounts
      • Withdraw funds from PAMM accounts
  • User guide
    • Sign-in and 2FA
    • Account details
      • Subscriptions page
      • Trading Report page
      • Statistics page
      • Settings page
      • Requests page (for PAMM accounts only)
      • Fee Payments page
    • Use the Leaderboard to find the best-performing master accounts
    • Manage master and investment accounts
      • Create a master account
      • Set up or modify a fee plan for your master account
      • Change your master account visibility on the Leaderboard
      • Assign a subscription code to your master account
      • Assign a minimum deposit to your master account
      • Set up a promo offer for your master account
      • View and update rollover settings of your PAMM master account
      • Create an investment account
      • Add your profile picture and nickname
      • Add or change your account name
      • Reset your account password
    • Manage subscriptions
      • Create a subscription
      • Create a subscription using a subscription code
      • Create a subscription using a promo code
      • Change a risk ratio and allocation method for a subscription
      • Assign a risk limit to a subscription
      • Enable or disable the reverse copy option for a subscription
      • Check a fee plan applied to a subscription
      • Detach open positions copied into investment accounts
      • Pause or resume a subscription
      • Terminate and reactivate a subscription
    • Manage deposits and withdrawals
      • Deposit funds to your copy-trading and MAM accounts
      • Withdraw funds from your copy-trading and MAM accounts
      • Deposit funds to your PAMM accounts
      • Withdraw funds from your PAMM accounts
  • Copy-trading, PAMM, and MAM concepts
    • General comparison of copy-trading PAMM and MAM accounts
    • Allocation methods for copy trading and MAM
    • Allocation methods for PAMM
      • Reallocation on deposit and withdrawal
      • No action on deposit and autocorrection on withdrawal
    • Fee list
    • Return calculation
    • Drawdown and Maximum drawdown calculation
    • Risk limits for investors
    • Risk limits for master traders
    • Score calculation
  • API Documentation
    • Authorization in the Back Office
    • Get a list of master and investment accounts
    • Create a master or investment account using the existing MT account
    • Get data for the Statistics widget
    • Get data for the Leaderboard widget
    • Seamless authorization (only for a standalone solution)
    • Register a client and create their payment account (only for a standalone solution)
  • Video tutorials
  • Key terms
  • Release notes
Powered by GitBook
On this page
  • Request
  • Response

Was this helpful?

  1. API Documentation

Get a list of master and investment accounts

Retrieve a list of master and investment accounts created on the B2COPY investment platform using this API method

PreviousAuthorization in the Back OfficeNextCreate a master or investment account using the existing MT account

Last updated 7 days ago

Was this helpful?

Use the method described below to get a list of master and investment accounts created on the B2COPY investment platform.

GET [host]/api/v2/b2copy/accounts

Request

Headers

Authorization: Bearer <access_token>

To get the access token, use the method to .

Body

‍In the request body, specify the following parameters:

Name
Type
Required
Description

investmentPlatformId

integer

Yes

The identifier of the investment platform instance.

  • If only one MT server is connected to your B2COPY investment platform, specify 1.

  • If you have more than one MT server connected to your B2COPY investment platform, contact the Support team for assistance.

account_number

string

No

Specify the MT login (number) of a master or investment account to get data about a specific account.

email

string

No

Specify the client email address to get data about accounts of a specific client.

is_master

boolean

No

If true, only master accounts are returned. If false, only investment accounts are returned.

limit

integer

No

Specify this parameter to define the maximum number of items that may be returned in a response.

offset

integer

No

Specify this parameter to exclude from a response the first N items of a resource collection.

sort_by

string

No

Sorts the items in the response by a specified parameter. Possible value: - created_at – the date and time when a master or investment account was created.

sort_order

string

No

Sorts the items in the response in a specified order. Possible values: - asc – the ascending order - desc – the descending order

Request example

curl --location --request GET 'https://host.name/api/v2/b2copy/accounts' \
--header 'Authorization: Bearer <accesss_token>' \
--data-raw '{
    "investment_platform_id": 1,
    "account_number": "2121944013",
    "email": "username@bexample.com",
    "is_master": true,
    "limit": 100,
    "offset": 0,
    "sort_by": "created_at",
    "sort_order": "asc"
}'

Response

The response includes an array of objects providing information about master and investment accounts matching the request parameters.

Response example

{
    "firstName": "John",
    "lastName": "Smith",
    "email": "username@example.com",
    "account_id": "2121944013",
    "group": "demo_standalone",
    "account_type": "master",
    "createdAt": "2024-02-09T10:32:47.000000Z"
}
authorize in the Back Office