# List Top Actives

Retrieves stock top active rank list

# OpenAPI definition

```json
{
  "info": {
    "title": "Webull Open API Reference",
    "description": "application.yml\\ncom\\ni18n\\nMETA-INF\\nstatic\\n\\r\\n",
    "contact": {
      "name": "",
      "url": "",
      "email": ""
    },
    "version": "2.0",
    "x-logo": {
      "url": "static/png/logo.png"
    }
  },
  "servers": [
    {
      "url": "https://hk-co-branding-openapi.uat.webullbroker.com"
    }
  ],
  "path": "/market-data/screeners/top-actives/list",
  "method": "get",
  "tags": [
    "Screeners"
  ],
  "description": "Retrieves stock top active rank list",
  "operationId": "topActiveUsingGETNew",
  "parameters": [
    {
      "name": "rank_type",
      "in": "query",
      "description": "Rank list type",
      "required": false,
      "schema": {
        "type": "string",
        "description": "Rank Types",
        "enum": [
          "VOLUME",
          "RELATIVE_VOLUME_10D",
          "TURNOVER",
          "TURNOVER_RATE",
          "AMPLITUDE"
        ]
      },
      "example": "VOLUME"
    },
    {
      "name": "category",
      "in": "query",
      "description": "Security category",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "US_STOCK"
        ]
      },
      "example": "US_STOCK"
    },
    {
      "name": "sort_by",
      "in": "query",
      "description": "Sort Field",
      "required": false,
      "schema": {
        "type": "string",
        "enum": [
          "CHANGE_RATIO",
          "RELATIVE_VOLUME_10D",
          "MARKET_VALUE",
          "CLOSE",
          "PRICE",
          "PE_TTM",
          "HIGH",
          "LOW",
          "AMPLITUDE",
          "TURNOVER",
          "VOLUME"
        ]
      },
      "example": "VOLUME"
    },
    {
      "name": "direction",
      "in": "query",
      "description": "Sorting direction. Ascending order: ASC, descending order: DESC",
      "required": false,
      "schema": {
        "type": "string",
        "enum": [
          "ASC",
          "DESC"
        ]
      },
      "example": "DESC"
    },
    {
      "name": "pagination_key",
      "in": "query",
      "description": "Pagination key returned from previous page response. Pass null or omit for first page.",
      "required": false,
      "schema": {
        "type": "string"
      },
      "example": "eyJ2IjoxLCJwYWdlSW5kZXgiOjJ9"
    },
    {
      "name": "access_token",
      "in": "header",
      "description": "User's authenticated token.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "reqid",
      "in": "header",
      "description": "The unique ID for this request. Suggest using UUID.",
      "schema": {
        "type": "string"
      },
      "example": "2e46d5a4-bef9-4507-8cda-98f85d2f770c"
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "type": "array",
                "description": "Data list",
                "items": {
                  "type": "object",
                  "properties": {
                    "symbol": {
                      "type": "string",
                      "description": "Security symbol",
                      "example": "TSLA"
                    },
                    "name": {
                      "type": "string",
                      "description": "Security name",
                      "example": "Tesla Inc"
                    },
                    "exchange_code": {
                      "type": "string",
                      "description": "Exchange code",
                      "example": "NSQ"
                    },
                    "currency": {
                      "type": "string",
                      "description": "Currency code",
                      "example": "USD"
                    },
                    "pre_close": {
                      "type": "string",
                      "description": "The closing price of the previous trading day",
                      "example": "11.01"
                    },
                    "open": {
                      "type": "string",
                      "description": "Open price for the current trading day",
                      "example": "11.01"
                    },
                    "high": {
                      "type": "string",
                      "description": "Today’s high",
                      "example": "12.11"
                    },
                    "low": {
                      "type": "string",
                      "description": "Today’s low",
                      "example": "11.01"
                    },
                    "close": {
                      "type": "string",
                      "description": "Latest intraday prices for the current trading day",
                      "example": "12.01"
                    },
                    "price": {
                      "type": "string",
                      "description": "The latest price for the current trading day",
                      "example": "11.11"
                    },
                    "change": {
                      "type": "string",
                      "description": "Trade change for the current trading day",
                      "example": "1.01"
                    },
                    "change_ratio": {
                      "type": "string",
                      "description": "Price change ratio relative to previous close. Expressed as a decimal (e.g., 0.0111 = 1.11%)",
                      "example": "0.0111"
                    },
                    "volume": {
                      "type": "string",
                      "description": "Trade volume",
                      "format": "0",
                      "example": "1111111"
                    },
                    "turnover": {
                      "type": "string",
                      "description": "Transaction amount, US market stocks and ETFs do not return this data under Nb authorization",
                      "format": "0.00##",
                      "example": "1234567890"
                    },
                    "turnover_rate": {
                      "type": "string",
                      "description": "Turnover Rate",
                      "example": "0.1111"
                    },
                    "market_value": {
                      "type": "string",
                      "description": "Market Value",
                      "format": "0.00##",
                      "example": "12345678901"
                    },
                    "amplitude": {
                      "type": "string",
                      "description": "Amplitude Ratio",
                      "example": "0.1111"
                    },
                    "relative_volume_10d": {
                      "type": "string",
                      "description": "10 day average trading volume ratio",
                      "format": "0.00##",
                      "example": "11.91"
                    }
                  },
                  "description": "Data list",
                  "title": "StandardActiveRankItemVO"
                }
              },
              "pagination_key": {
                "type": "string",
                "description": "Pagination key for next page. null means no more data.",
                "example": "eyJ2IjoxLCJwYWdlSW5kZXgiOjJ9"
              }
            },
            "title": "ActiveRankPageResponse"
          }
        }
      }
    }
  },
  "postman": {
    "name": "List Top Actives",
    "description": {
      "content": "Retrieves stock top active rank list",
      "type": "text/plain"
    },
    "url": {
      "path": [
        "market-data",
        "screeners",
        "top-actives",
        "list"
      ],
      "host": [
        "{{baseUrl}}"
      ],
      "query": [
        {
          "disabled": false,
          "description": {
            "content": "Rank list type",
            "type": "text/plain"
          },
          "key": "rank_type",
          "value": ""
        },
        {
          "disabled": false,
          "description": {
            "content": "(Required) Security category",
            "type": "text/plain"
          },
          "key": "category",
          "value": ""
        },
        {
          "disabled": false,
          "description": {
            "content": "Sort Field",
            "type": "text/plain"
          },
          "key": "sort_by",
          "value": ""
        },
        {
          "disabled": false,
          "description": {
            "content": "Sorting direction. Ascending order: ASC, descending order: DESC",
            "type": "text/plain"
          },
          "key": "direction",
          "value": ""
        },
        {
          "disabled": false,
          "description": {
            "content": "Pagination key returned from previous page response. Pass null or omit for first page.",
            "type": "text/plain"
          },
          "key": "pagination_key",
          "value": ""
        }
      ],
      "variable": []
    },
    "header": [
      {
        "disabled": false,
        "description": {
          "content": "(Required) User's authenticated token.",
          "type": "text/plain"
        },
        "key": "access_token",
        "value": ""
      },
      {
        "disabled": false,
        "description": {
          "content": "The unique ID for this request. Suggest using UUID.",
          "type": "text/plain"
        },
        "key": "reqid",
        "value": ""
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "method": "GET"
  }
}
```
