Grid Bot Profits

Description: Returns profit data for a specific Grid Line associated with a Grid Bot, identified by its unique 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

Body Parameters

id string Filters the Grid Bots created after a specific date. Use an ISO 8601 datetime string as the value

id string Filters the Grid Bots created before a specific date. Use an ISO 8601 datetime string as the value

If the from and to values are not set, the response will include all records ordered in descending ([DESC]) order.

Response Parameters

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

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

grid_line object Details about a specific Grid line event

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 string Indicates whether the order for this Grid line has been placed

Example Request

GET /ver1/grid_bots/2338357/profits

Example Response and errors

Status: 200 OK

[
    {
        "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": 256427676,
        "profit": "0.0673937919894358",
        "usd_profit": "0.0673937919894358",
        "created_at": "2024-10-03T20:01:44.874Z",
        "grid_line": {
            "id": 256427676,
            "price": "0.022059",
            "side": "buy",
            "order_placed": true
        }
    }
]

Status: 401 Unauthorized

{
    "error": "signature_invalid",
    "error_description": "Provided signature is invalid"
}