Skip to main content

MetaCopier API

Project description

metacopier-api

Explore the power of the MetaCopier API! Our RESTful API offers scalable and secure access to accounts, projects, and more. Get started quickly with authentication, explore endpoints, and access code samples in various languages.

All dates are in ISO 8601

This API is not designed for real-time communication purposes. For instance, continuously polling account information such as open positions every second is not recommended.

Our frontend uses this API, so you can look at the requests on our frontend for examples.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.2.5
  • Package version: 1.0.0
  • Generator version: 7.14.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://metacopier.io

Requirements.

Python 3.9+

Installation & Usage

pip install

You can install directly using:

pip install metacopier-api

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import metacopier_api

Getting Started

Please follow the installation procedure and then run the following:

import metacopier_api
from metacopier_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.metacopier.io
# See configuration.py for a list of all supported configuration parameters.
configuration = metacopier_api.Configuration(
    host = "https://api.metacopier.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with metacopier_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = metacopier_api.AccountAPIApi(api_client)
    account_id = 'account_id_example' # str |

    try:
        # Activate all copiers of all slave accounts
        api_instance.activate_slaves_copier(account_id)
    except ApiException as e:
        print("Exception when calling AccountAPIApi->activate_slaves_copier: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.metacopier.io

Class Method HTTP request Description
AccountAPIApi activate_slaves_copier POST /rest/api/v1/accounts/{accountId}/activateSlavesCopier Activate all copiers of all slave accounts
AccountAPIApi create_account POST /rest/api/v1/accounts Create an account
AccountAPIApi create_account_approval POST /rest/api/v1/accounts/{accountId}/approvals Create an approval
AccountAPIApi create_account_feature POST /rest/api/v1/accounts/{accountId}/features Create an account feature
AccountAPIApi create_copier POST /rest/api/v1/accounts/{accountId}/copiers Create an account copier
AccountAPIApi create_copier_feature POST /rest/api/v1/accounts/{accountId}/copiers/{copierId}/features Create a copier feature
AccountAPIApi create_risk_limit POST /rest/api/v1/accounts/{accountId}/riskLimits Create an account risk limit
AccountAPIApi deactivate_slaves_copier POST /rest/api/v1/accounts/{accountId}/deactivateSlavesCopier Deactivate all copiers of all slave accounts
AccountAPIApi delete_account DELETE /rest/api/v1/accounts/{accountId} Delete an account
AccountAPIApi delete_account_feature DELETE /rest/api/v1/accounts/{accountId}/features/{featureId} Delete an account feature
AccountAPIApi delete_copier DELETE /rest/api/v1/accounts/{accountId}/copiers/{copierId} Delete an account copier
AccountAPIApi delete_copier_feature DELETE /rest/api/v1/accounts/{accountId}/copiers/{copierId}/features/{featureId} Delete a copier feature
AccountAPIApi delete_risk_limit DELETE /rest/api/v1/accounts/{accountId}/riskLimits/{riskLimitId} Delete an account risk limit
AccountAPIApi get_account GET /rest/api/v1/accounts/{accountId} Get an account
AccountAPIApi get_account_copier_current_symbol_mappings GET /rest/api/v1/accounts/{accountId}/copiers/{copierId}/symbolMappings/current Get account copier current symbol mappings
AccountAPIApi get_account_feature GET /rest/api/v1/accounts/{accountId}/features/{featureId} Get an account feature
AccountAPIApi get_account_features GET /rest/api/v1/accounts/{accountId}/features Get all account features
AccountAPIApi get_account_logs GET /rest/api/v1/accounts/{accountId}/logs Get account logs
AccountAPIApi get_account_performance_metrics GET /rest/api/v1/accounts/{accountId}/performanceMetrics Get an account performance metrics
AccountAPIApi get_account_symbol_mappings POST /rest/api/v1/accounts/{accountId}/symbolMappings Get account symbol mappings for given symbols
AccountAPIApi get_accounts GET /rest/api/v1/accounts Get all accounts
AccountAPIApi get_copier GET /rest/api/v1/accounts/{accountId}/copiers/{copierId} Get account copier
AccountAPIApi get_copier_feature GET /rest/api/v1/accounts/{accountId}/copiers/{copierId}/features/{featureId} Get a copier feature
AccountAPIApi get_copier_features GET /rest/api/v1/accounts/{accountId}/copiers/{copierId}/features Get all copier features
AccountAPIApi get_copiers GET /rest/api/v1/accounts/{accountId}/copiers Get account copiers
AccountAPIApi get_risk_limit GET /rest/api/v1/accounts/{accountId}/riskLimits/{riskLimitId} Get an account risk limit
AccountAPIApi get_risk_limits GET /rest/api/v1/accounts/{accountId}/riskLimits Get account risk limits
AccountAPIApi reset_profit_target PUT /rest/api/v1/accounts/{accountId}/profitTargets/{profitTargetFeatureId}/reset Reset an account profit target
AccountAPIApi reset_risk_limit PUT /rest/api/v1/accounts/{accountId}/riskLimits/{riskLimitId}/reset Reset an account risk limit
AccountAPIApi resync_copier POST /rest/api/v1/accounts/{accountId}/copiers/{copierId}/resync Resynchronize copier with master
AccountAPIApi start_account POST /rest/api/v1/accounts/{accountId}/actions/start Start an account (connect)
AccountAPIApi stop_account POST /rest/api/v1/accounts/{accountId}/actions/stop Stop an account (disconnect)
AccountAPIApi update_account PUT /rest/api/v1/accounts/{accountId} Update an account
AccountAPIApi update_account_feature PUT /rest/api/v1/accounts/{accountId}/features/{featureId} Update an account feature
AccountAPIApi update_copier PUT /rest/api/v1/accounts/{accountId}/copiers/{copierId} Update an account copier
AccountAPIApi update_copier_feature PUT /rest/api/v1/accounts/{accountId}/copiers/{copierId}/features/{featureId} Update a copier feature
AccountAPIApi update_risk_limit PUT /rest/api/v1/accounts/{accountId}/riskLimits/{riskLimitId} Update an account risk limit
MarketplaceAPIApi get_marketplace GET /rest/api/v1/marketplace Get marketplace data
ProjectAPIApi acknowledge_all_logs PUT /rest/api/v1/projects/{projectId}/logs/acknowledgeAll Acknowledge all logs
ProjectAPIApi acknowledge_log PUT /rest/api/v1/projects/{projectId}/logs/{id}/acknowledge Acknowledge a log
ProjectAPIApi acknowledge_logs_bulk PUT /rest/api/v1/projects/{projectId}/logs/acknowledge/bulk
ProjectAPIApi close_all_positions_in_all_accounts POST /rest/api/v1/projects/{projectId}/closeAllPositions Close all open positions in all accounts
ProjectAPIApi create_project_feature POST /rest/api/v1/projects/{projectId}/features Create a project feature
ProjectAPIApi create_project_strategy POST /rest/api/v1/projects/{projectId}/strategies Create a strategy
ProjectAPIApi create_project_strategy_copier POST /rest/api/v1/projects/{projectId}/strategies/{strategyId}/copiers Create a strategy copier
ProjectAPIApi create_project_strategy_copier_feature POST /rest/api/v1/projects/{projectId}/strategies/{strategyId}/copiers/{copierId}/features Create a strategy copier feature
ProjectAPIApi create_project_symbol_mapping POST /rest/api/v1/projects/{projectId}/symbolMappings Create a symbol mapping
ProjectAPIApi delete_project_feature DELETE /rest/api/v1/projects/{projectId}/features/{featureId} Delete a project feature
ProjectAPIApi delete_project_strategy DELETE /rest/api/v1/projects/{projectId}/strategies/{strategyId} Delete a strategy
ProjectAPIApi delete_project_strategy_copier DELETE /rest/api/v1/projects/{projectId}/strategies/{strategyId}/copiers/{copierId} Delete a strategy copier
ProjectAPIApi delete_project_strategy_copier_feature DELETE /rest/api/v1/projects/{projectId}/strategies/{strategyId}/copiers/{copierId}/features/{featureId} Delete a strategy copier feature
ProjectAPIApi delete_project_symbol_mapping DELETE /rest/api/v1/projects/{projectId}/symbolMappings/{symbolMappingId} Delete a symbol mapping
ProjectAPIApi get_available_labels GET /rest/api/v1/projects/{projectId}/labels Get available labels (for account)
ProjectAPIApi get_forecast_cost GET /rest/api/v1/projects/{projectId}/costs/forecast Retrieve forecast cost for a specific project
ProjectAPIApi get_invoices GET /rest/api/v1/projects/{projectId}/invoices Get all invoices
ProjectAPIApi get_project GET /rest/api/v1/projects/{projectId} Get a project
ProjectAPIApi get_project_available_signals_to_follow GET /rest/api/v1/projects/{projectId}/signals Get available signals
ProjectAPIApi get_project_feature GET /rest/api/v1/projects/{projectId}/features/{featureId} Get a project feature
ProjectAPIApi get_project_features GET /rest/api/v1/projects/{projectId}/features Get all project features
ProjectAPIApi get_project_logs GET /rest/api/v1/projects/{projectId}/logs Get project logs
ProjectAPIApi get_project_strategies GET /rest/api/v1/projects/{projectId}/strategies Get all strategies
ProjectAPIApi get_project_strategy GET /rest/api/v1/projects/{projectId}/strategies/{strategyId} Get a strategy
ProjectAPIApi get_project_strategy_copier GET /rest/api/v1/projects/{projectId}/strategies/{strategyId}/copiers/{copierId} Get strategy copier
ProjectAPIApi get_project_strategy_copier_feature GET /rest/api/v1/projects/{projectId}/strategies/{strategyId}/copiers/{copierId}/features/{featureId} Get a strategy copier feature
ProjectAPIApi get_project_strategy_copier_features GET /rest/api/v1/projects/{projectId}/strategies/{strategyId}/copiers/{copierId}/features Get all strategy copier features
ProjectAPIApi get_project_strategy_copiers GET /rest/api/v1/projects/{projectId}/strategies/{strategyId}/copiers Get strategy copiers
ProjectAPIApi get_project_symbol_mapping GET /rest/api/v1/projects/{projectId}/symbolMappings/{symbolMappingId} Get a symbol mapping
ProjectAPIApi get_project_symbol_mappings GET /rest/api/v1/projects/{projectId}/symbolMappings Get symbol mappings
ProjectAPIApi get_project_transactions GET /rest/api/v1/projects/{projectId}/transactions Get project transactions
ProjectAPIApi resync_strategy_copier POST /rest/api/v1/projects/{projectId}/strategies/{strategyId}/copiers/{copierId}/resync Resync copier with master
ProjectAPIApi update_project PUT /rest/api/v1/projects/{projectId} Update a project
ProjectAPIApi update_project_feature PUT /rest/api/v1/projects/{projectId}/features/{featureId} Update a project feature
ProjectAPIApi update_project_strategy PUT /rest/api/v1/projects/{projectId}/strategies/{strategyId} Update a strategy
ProjectAPIApi update_project_strategy_copier PUT /rest/api/v1/projects/{projectId}/strategies/{strategyId}/copiers/{copierId} Update a strategy copier
ProjectAPIApi update_project_strategy_copier_feature PUT /rest/api/v1/projects/{projectId}/strategies/{strategyId}/copiers/{copierId}/features/{featureId} Update a strategy copier feature
ProjectAPIApi update_project_symbol_mapping PUT /rest/api/v1/projects/{projectId}/symbolMappings/{symbolMappingId} Update a symbol mapping
ReportAPIApi create_report_performance POST /rest/api/v1/reports/performance Create a performance report
SignalAPIApi close_all_positions_in_all_follower_accounts POST /rest/api/v1/signals/{signalProviderId}/closeAllPositions Close all open positions in all accounts (followers)
SignalAPIApi close_signal_follower_all_positions POST /rest/api/v1/signals/{signalProviderId}/accounts/{accountId}/actions/closeAllPositions Close all signal follower account positions
SignalAPIApi close_signal_follower_position DELETE /rest/api/v1/signals/{signalProviderId}/accounts/{accountId}/positions/{positionId} Close an signal follower account position
SignalAPIApi get_follower_feature GET /rest/api/v1/signals/{signalProviderId}/accounts/{accountId}/followerFeature Get follower feature
SignalAPIApi get_signal_follower_account_history_positions GET /rest/api/v1/signals/{signalProviderId}/accounts/{accountId}/history/positions Get signal follower account history positions
SignalAPIApi get_signal_follower_account_logs GET /rest/api/v1/signals/{signalProviderId}/accounts/{accountId}/logs Get signal follower account logs
SignalAPIApi get_signal_follower_account_performance_metrics GET /rest/api/v1/signals/{signalProviderId}/accounts/{accountId}/performanceMetrics Get signal follower account performance metrics
SignalAPIApi get_signal_follower_account_positions GET /rest/api/v1/signals/{signalProviderId}/accounts/{accountId}/positions Get signal follower account positions
SignalAPIApi get_signal_follower_accounts GET /rest/api/v1/signals/{signalProviderId}/accounts Get all signal follower accounts
SignalAPIApi get_signal_symbols GET /rest/api/v1/signals/{signalProviderId}/accounts/{accountId}/symbols Get signal follower account symbols
SignalAPIApi update_follower_feature PUT /rest/api/v1/signals/{signalProviderId}/accounts/{accountId}/followerFeature Update follower feature
TradingAPIApi close_all_positions POST /rest/api/v1/accounts/{accountId}/actions/closeAllPositions Close all account positions
TradingAPIApi close_position DELETE /rest/api/v1/accounts/{accountId}/positions/{positionId} Close an account position
TradingAPIApi get_history_positions GET /rest/api/v1/accounts/{accountId}/history/positions Get account history positions
TradingAPIApi get_information GET /rest/api/v1/accounts/{accountId}/information Get account information
TradingAPIApi get_positions GET /rest/api/v1/accounts/{accountId}/positions Get account positions
TradingAPIApi get_symbols GET /rest/api/v1/accounts/{accountId}/symbols Get account symbols
TradingAPIApi modify_position PUT /rest/api/v1/accounts/{accountId}/positions/{positionId} Modify an account position
TradingAPIApi open_position POST /rest/api/v1/accounts/{accountId}/positions Open an account position
TradingAPIApi send_order POST /rest/api/v1/accounts/{accountId}/orders Send an account order
TypeAPIApi get_account_types GET /rest/api/v1/types/accountTypes Get account type enum
TypeAPIApi get_currency_types GET /rest/api/v1/types/currencyTypes Get currency type enum
TypeAPIApi get_feature_types GET /rest/api/v1/types/featureTypes Get feature type enum
TypeAPIApi get_log_types GET /rest/api/v1/types/logTypes Get log type enum
TypeAPIApi get_notification_category_types GET /rest/api/v1/types/notificationCategoryTypes Get notification category type enum
TypeAPIApi get_proxy_regions GET /rest/api/v1/types/proxyRegions Get proxy region enum
TypeAPIApi get_regions GET /rest/api/v1/types/regions Get region enum
TypeAPIApi get_risk_types GET /rest/api/v1/types/riskTypes Get risk type enum
TypeAPIApi get_scale_types GET /rest/api/v1/types/scaleTypes Get scale type enum

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

  • Type: API key
  • API key parameter name: X-API-KEY
  • Location: HTTP header

Author

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

metacopier_api-1.2.5.tar.gz (125.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

metacopier_api-1.2.5-py3-none-any.whl (220.9 kB view details)

Uploaded Python 3

File details

Details for the file metacopier_api-1.2.5.tar.gz.

File metadata

  • Download URL: metacopier_api-1.2.5.tar.gz
  • Upload date:
  • Size: 125.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.5

File hashes

Hashes for metacopier_api-1.2.5.tar.gz
Algorithm Hash digest
SHA256 60fd56e7ecb5050cdcb3e1fd8def1701e6be5f403fb5a7496368eb07d0052275
MD5 1f69c8ba8577742ab79a8150585bcc8b
BLAKE2b-256 fb09cf49e835d662b7ba0c7e0e561431f1a4ab45accfc2e765dde0cf3aa16caa

See more details on using hashes here.

File details

Details for the file metacopier_api-1.2.5-py3-none-any.whl.

File metadata

  • Download URL: metacopier_api-1.2.5-py3-none-any.whl
  • Upload date:
  • Size: 220.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.5

File hashes

Hashes for metacopier_api-1.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 b1fdf762d706c29e1cc3992919414fa51d0b6fcc4af7480f117386a67f5251f5
MD5 37d4dea9ebab3e5b24027c6f34c70da8
BLAKE2b-256 cc29c7d0a4073f718cb4a197d3aeb1448197cba9a72fc31085ba98ab819ca748

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page