Rank Categories

Get the tag category configuration for the popularity leaderboard. second_tags[].key can be passed to rank_list.

CLI

longbridge rank

SDK Links

Python	longbridge.openapi.MarketContext.rank_categories
Rust	longbridge::market::MarketContext#rank_categories
Go	MarketContext.RankCategories
Node.js	MarketContext#rankCategories
Java	MarketContext.getRankCategories
C++	longbridge::market::MarketContext::rank_categories

Parameters

SDK method parameters.

This method takes no parameters.

Request Example

from longbridge.openapi import MarketContext, Config, OAuthBuilder

oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url))
config = Config.from_oauth(oauth)
ctx = MarketContext(config)

resp = ctx.rank_categories()
print(resp)

import asyncio
from longbridge.openapi import AsyncMarketContext, Config, OAuthBuilder

async def main() -> None:
    oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("Visit:", url))
    config = Config.from_oauth(oauth)
    ctx = AsyncMarketContext.create(config)

    resp = await ctx.rank_categories()
    print(resp)

if __name__ == "__main__":
    asyncio.run(main())

const { Config, MarketContext, OAuth } = require('longbridge')

async function main() {
  const oauth = await OAuth.build('your-client-id', (_, url) => {
    console.log('Open this URL to authorize: ' + url)
  })
  const config = Config.fromOAuth(oauth)
  const ctx = MarketContext.new(config)
  const resp = await ctx.rankCategories()
  console.log(resp)
}
main().catch(console.error)

import com.longbridge.*;
import com.longbridge.market.*;

class Main {
    public static void main(String[] args) throws Exception {
        try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get();
             Config config = Config.fromOAuth(oauth);
             MarketContext ctx = MarketContext.create(config)) {
            var resp = ctx.getRankCategories().get();
            System.out.println(resp);
        }
    }
}

use std::sync::Arc;
use longbridge::{oauth::OAuthBuilder, market::MarketContext, Config};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("Open: {url}")).await?;
    let config = Arc::new(Config::from_oauth(oauth));
    let ctx = MarketContext::new(config);
    let resp = ctx.rank_categories().await?;
    println!("{:?}", resp);
    Ok(())
}

#include <iostream>
#include <longbridge.hpp>

using namespace longbridge;
using namespace longbridge::market;

int main() {
    OAuthBuilder("your-client-id").build(
        [](const std::string& url) { std::cout << "Open: " << url << std::endl; },
        [](auto res) {
            if (!res) return;
            Config config = Config::from_oauth(*res);
            MarketContext ctx = MarketContext::create(config);
            ctx.rank_categories([](auto resp) {
                if (resp) std::cout << "OK" << std::endl;
            });
        });
    std::cin.get();
}

package main

import (
	"context"
	"fmt"
	"log"

	"github.com/longbridge/openapi-go/config"
	"github.com/longbridge/openapi-go/oauth"
	"github.com/longbridge/openapi-go/market"
)

func main() {
	o := oauth.New("your-client-id").
		OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) })
	if err := o.Build(context.Background()); err != nil {
		log.Fatal(err)
	}
	conf, err := config.New(config.WithOAuthClient(o))
	if err != nil {
		log.Fatal(err)
	}
	c, err := market.NewFromCfg(conf)
	if err != nil {
		log.Fatal(err)
	}
	defer c.Close()
	resp, err := c.RankCategories(context.Background())
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", resp)
}

Response

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "first_tags": [
      {
        "key": "ib_hot",
        "name": "Hotness Rank",
        "second_tags": [
          { "key": "ib_hot_all-us", "name": "US Total Hotness", "market": "US" },
          { "key": "ib_hot_all-hk", "name": "HK Total Hotness", "market": "HK" },
          { "key": "ib_hot_all-cn", "name": "A-share Total Hotness", "market": "CN" }
        ]
      },
      {
        "key": "ib_change",
        "name": "Price Change Rank",
        "second_tags": [
          { "key": "ib_change_top-us", "name": "US Top Gainers", "market": "US" },
          { "key": "ib_change_top-hk", "name": "HK Top Gainers", "market": "HK" }
        ]
      }
    ]
  }
}

Response Status

Status	Description	Schema
200	Success	RankCategoriesResponse
400	Bad request	None

Schemas

RankCategoriesResponse

Name	Type	Required	Description
first_tags	object[]	false	Top-level category list
∟ key	string	false	Top-level category key
∟ name	string	false	Top-level category name
∟ second_tags	object[]	false	Second-level category list
∟ ∟ key	string	false	Second-level category key; pass to rank_list as the key parameter
∟ ∟ name	string	false	Second-level category name
∟ ∟ market	string	false	Associated market: US, HK, CN, SG