Skip to content

Commit

Permalink
Merge pull request #147 from feisk/feature/PLTF-475_v3_st_main_page
Browse files Browse the repository at this point in the history
PLTF-475
  • Loading branch information
kumomiX authored Feb 11, 2025
2 parents 38a8529 + 373af03 commit 74b0bed
Show file tree
Hide file tree
Showing 2 changed files with 88 additions and 26 deletions.
88 changes: 88 additions & 0 deletions docs/SmartTrade/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
import Endpoint from '@site/src/components/Endpoint';
import * as StickyLayout from '@site/src/components/StickyLayout';

# SmartTrade

<StickyLayout.Root>
<StickyLayout.Main>

The SmartTrade allows users to open, manage, and close orders on the exchange with predefined conditions.

3Commas provides a set of methods to create and manage SmartTrade entities and their associated trade entities.

A SmartTrade entity holds information, including:

* Exchange account and trading pair;
* Position data;
* Conditions for Take Profit and Stop Loss;
* Conditions for closing at market;
* Conditions for reducing funds.

The process starts with a SmartTrade entity, where all conditions are configured.

SmartTrade then manages trades, which are automatically created by 3Commas based on the conditions set within the SmartTrade entity.

SmartTrade can include the following trade types:

* Position trade;
* Take profit trade;
* Stop-loss trade;
* Reduce funds trade;
* Market close trade;

</StickyLayout.Main>

<StickyLayout.Sticky>
<Endpoint
endpointsList={[
{
url: "/v2/smart_trades",
method: 'POST'
},
{
url: "/v2/smart_trades/:id",
method: 'PATCH'
},
{
url: "/v2/smart_trades/:id",
method: 'GET'
},
{
url: "/v2/smart_trades",
method: 'GET'
},
{
url: "/v2/smart_trades/:id/add_funds",
method: 'POST'
},
{
url: "/v2/smart_trades/:id/reduce_funds_info",
method: 'GET'
},
{
url: "/v2/smart_trades/:id/reduce_funds",
method: 'POST'
},
{
url: "/v2/smart_trades/:id/close_by_market",
method: 'POST'
},
{
url: "/v2/smart_trades/:id/set_note",
method: 'POST'
},
{
url: "/v2/smart_trades/:id",
method: 'DELETE'
},
{
url: "/v2/smart_trades/:id/force_start",
method: 'POST'
}
]}
/>

</StickyLayout.Sticky>
</StickyLayout.Root>


26 changes: 0 additions & 26 deletions docs/SmartTrade/README.mdx

This file was deleted.

0 comments on commit 74b0bed

Please sign in to comment.