> For the complete documentation index, see [llms.txt](https://docs.openalgo.in/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openalgo.in/api-documentation/v1/accounts-api/analyzer-status.md).

# Analyzer Status

## Endpoint URL

This API Function fetches the stock holdings details from the broker

```http
Local Host   :  POST http://127.0.0.1:5000/api/v1/analyzer
Ngrok Domain :  POST https://<your-ngrok-domain>.ngrok-free.app/api/v1/analyzer
Custom Domain:  POST https://<your-custom-domain>/api/v1/analyzer
```

## Sample API Request

```json
{
    "apikey": "<your_app_apikey>"
}

```

## Sample API Response

```json
{
  "data": {
    "analyze_mode": false,
    "mode": "live",
    "total_logs": 2
  },
  "status": "success"
}
```

### Request Body

| Parameter | Type   | Required | Description           |
| --------- | ------ | -------- | --------------------- |
| apikey    | string | Yes      | Your OpenAlgo API key |

### Response Fields

| Field         | Type    | Description                                                 |
| ------------- | ------- | ----------------------------------------------------------- |
| status        | string  | Status of the API call (success/error)                      |
| data          | object  | Container for response data                                 |
| mode          | string  | Current mode in human-readable format ("analyze" or "live") |
| analyze\_mode | boolean | Current analyzer mode flag (true = analyze, false = live)   |
| total\_logs   | integer | Total number of analyzer logs stored                        |

### Notes

* **Live Mode**: When `analyze_mode` is `false`, all API calls execute actual broker operations
* **Analyze Mode**: When `analyze_mode` is `true`, all API calls return simulated responses without executing real trades
* The `total_logs` field shows the cumulative count of all analyzer mode operations logged in the system
* This endpoint is useful for checking the current mode before executing trading operations
* Rate limited to 10 requests per second per API key


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.openalgo.in/api-documentation/v1/accounts-api/analyzer-status.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
