Skip to main content
GET
/
api
/
month
/
{month}
Get Month Data
curl --request GET \
  --url https://api.example.com/api/month/{month}
{
  "success": true,
  "summary": {
    "month": "<string>",
    "total_trades": 123,
    "winning_trades": 123,
    "win_rate": 123,
    "trading_profit_loss": 123,
    "total_dividends": 123,
    "total_return_with_dividends": 123
  },
  "trades": [
    {}
  ],
  "dividends": [
    {}
  ]
}

​
Endpoint

GET /api/month/{month}

​
Path Parameters

​
month
string
required
Month in YYYY-MM format (e.g., “2024-08”)

​
Authentication

Requires OAuth 2.0 authentication via session cookies.

​
Response

Returns detailed trading data including summary, trades, and dividends.
​
success
boolean
required
Request success status
​
summary
object
required
Monthly summary statistics
​
trades
array
required
List of completed trades
​
dividends
array
required
List of dividend payments

​
Example

curl -X GET https://your-domain.com/api/month/2024-08 \
  -H "Cookie: session=your_session_cookie"

​
Response Example

{
  "success": true,
  "summary": {
    "month": "2024-08",
    "total_trades": 15,
    "winning_trades": 9,
    "win_rate": 60.0,
    "trading_profit_loss": 850.75,
    "total_dividends": 125.50,
    "total_return_with_dividends": 976.25
  },
  "trades": [
    {
      "symbol": "AAPL",
      "buy_date": "2024-08-01",
      "sell_date": "2024-08-15",
      "buy_price": 195.50,
      "sell_price": 198.75,
      "volume": 100,
      "total_profit_loss": 325.00,
      "return_percentage": 1.66,
      "trade_result": "Win"
    }
  ],
  "dividends": [
    {
      "transaction_date": "2024-08-15",
      "symbol": "MSFT",
      "action": "Cash Dividend",
      "amount": 75.50
    }
  ],
  "data_source": "postgresql"
}