Get profit details of Grid Bot

Description: Returns profit details of existing Grid Bot using its ID

Permission: BOTS_READ Security: SIGNED

GET

/ver1/grid_bots/{id}/profits

Path Parameter

id integer required Unique 3Commas ID for this Grid Bot entity

Query parameters

from string Filters Grid Bots created after a specific date in ISO 8601 format

to string Filters the Grid Bots created before a specific date in ISO 8601 format

If the from and to values are not set, the response will include all records ordered in descending (DESC) order by ID parameter

Parameters response

grid_line_id string Unique 3Commas ID for this Grid line entity

profit string Profit amount from this Grid line event in the base currency

usd_profit string Profit amount in USD from this Grid line event

created_at string ISO 8601 datetime string indicating when the event was recorded

grid_line object [TBD]

id string Unique 3Commas ID for this Grid line entity

price string The price value at which the asset was bought or sold when this grid line was executed

side string Order side for this Grid line

order_placed boolean Indicates whether the order for this Grid line has been placed

Example Request

GET /ver1/grid_bots/2338357/profits?from=2024-09-01T04:00:00.000Z&to=2024-10-11T03:59:59.000Z

Example response and errors

Status: 201 Created

[
    {
        "grid_line_id": 256470631,
        "profit": "0.5387463715614246",
        "usd_profit": "0.5387463715614246",
        "created_at": "2024-10-06T11:45:47.500Z",
        "grid_line": {
            "id": 256470631,
            "price": "0.022954",
            "side": "buy",
            "order_placed": false
        }
    },
    {
        "grid_line_id": 256439950,
        "profit": "0.2721254846234494",
        "usd_profit": "0.2721254846234494",
        "created_at": "2024-10-04T16:23:16.731Z",
        "grid_line": {
            "id": 256439950,
            "price": "0.022503",
            "side": "buy",
            "order_placed": false
        }
    },
    ...
]

Last updated

Was this helpful?