List Sharelists

Get all community stock lists (sharelists) created by or subscribed to by the current user.

CLI

longbridge sharelist
longbridge sharelist --format json

SDK Links

Python	longbridge.openapi.SharelistContext.list_sharelist
Rust	longbridge::sharelist::SharelistContext#list_sharelist
Go	SharelistContext.ListSharelist
Node.js	SharelistContext#listSharelist
Java	SharelistContext.getListSharelist
C++	longbridge::sharelist::SharelistContext::list_sharelist

Parameters

SDK method parameters.

Name	Type	Required	Description
type	string	NO	Filter: mine or subscribed. Omit for both.

Request Example

from longbridge.openapi import SharelistContext, Config, OAuthBuilder

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

resp = ctx.list_sharelist()
print(resp)

import asyncio
from longbridge.openapi import AsyncSharelistContext, 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 = AsyncSharelistContext.create(config)

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

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

const { Config, SharelistContext, 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 = SharelistContext.new(config)
  const resp = await ctx.list_sharelist()
  console.log(resp)
}
main().catch(console.error)

import com.longbridge.*;
import com.longbridge.sharelist.*;

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);
             SharelistContext ctx = SharelistContext.create(config)) {
            var resp = ctx.getListSharelist().get();
            System.out.println(resp);
        }
    }
}

use std::sync::Arc;
use longbridge::{oauth::OAuthBuilder, sharelist::SharelistContext, 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 = SharelistContext::new(config);
    let resp = ctx.list_sharelist().await?;
    println!("{:?}", resp);
    Ok(())
}

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

using namespace longbridge;
using namespace longbridge::sharelist;

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);
            SharelistContext ctx = SharelistContext::create(config);
            ctx.list_sharelist([](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/sharelist"
)

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 := sharelist.NewFromCfg(conf)
	if err != nil {
		log.Fatal(err)
	}
	defer c.Close()
	resp, err := c.ListSharelist(context.Background())
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", resp)
}

Response

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "mine": [
      {
        "id": 15921,
        "name": "AI Picks",
        "type": "Regular",
        "day_change": "-0.40",
        "ytd_change": "6.64",
        "subscribers": 500
      }
    ],
    "subscribed": []
  }
}

Response Status

Status	Description	Schema
200	Success	SharelistListResponse
400	Bad request	None

Schemas

SharelistListResponse

Name	Type	Required	Description
sharelists	object[]	false	User's own sharelists, see SharelistInfo
subscribed_sharelists	object[]	false	Subscribed sharelists, see SharelistInfo
tail_mark	string	false	Pagination cursor for subscribed list

SharelistInfo

Name	Type	Required	Description
id	integer	true	Sharelist ID
name	string	false	Sharelist name
description	string	false	Description
cover	string	false	Cover image URL
subscribers_count	integer	false	Number of subscribers
chg	string	false	Day change percentage
this_year_chg	string	false	Year-to-date change percentage
subscribed	boolean	false	Whether the current user is subscribed
sharelist_type	integer	false	Type: 0=regular, 3=official, 4=industry
industry_code	string	false	Industry code (for industry sharelists)
stocks	object[]	false	Constituent stocks, see SharelistStock

SharelistStock

Name	Type	Required	Description
symbol	string	true	Security symbol
code	string	false	Ticker code
name	string	false	Security name
market	string	false	Market
intro	string	false	Brief description
last_done	string	false	Latest price
change	string	false	Day change percentage
trade_status	integer	false	Trade status code
latency	boolean	false	Whether quote data is delayed
unread_change_log_category	string	false	Unread change log category