Sharelist Detail

Get sharelist detail including name, description, and constituent stocks.

SDK Links

Python	longport.openapi.SharelistContext.detail
Rust	longport::sharelist::SharelistContext#detail
Go	SharelistContext.Detail
Node.js	SharelistContext#detail

Parameters

Name	Type	Required	Description
id	integer	YES	Sharelist ID

Request Example

from longport.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.detail(123)
print(resp)

import asyncio
from longport.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.detail(123)
    print(resp)

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

const { Config, SharelistContext, OAuth } = require('longport')

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.detail(123)
  console.log(resp)
}
main().catch(console.error)

import com.longport.*;
import com.longport.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.detail(123).get();
            System.out.println(resp);
        }
    }
}

use std::sync::Arc;
use longport::{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.detail(123).await?;
    println!("{:?}", resp);
    Ok(())
}

package main

import (
	"context"
	"fmt"
	"log"

	"github.com/longportapp/openapi-go/config"
	"github.com/longportapp/openapi-go/oauth"
	"github.com/longportapp/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.Detail(context.Background(), 123)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", resp)
}

Response

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "id": 123,
    "name": "AI Picks",
    "description": "Top AI infrastructure stocks",
    "securities": ["AAPL.US", "NVDA.US"]
  }
}

Response Status

Status	Description	Schema
200	Success	SharelistDetail
400	Bad request	None

Schemas

SharelistDetailResponse

Name	Type	Required	Description
sharelist	object	true	Sharelist information
scopes	object	false	Subscription scope info

SharelistInfo

Name	Type	Required	Description
id	integer	true	Sharelist ID
name	string	false	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
subscribed	boolean	false	Whether subscribed
sharelist_type	integer	false	Type: 0=regular, 3=official, 4=industry
industry_code	string	false	Industry code
stocks	object[]	false	Constituent stocks, see SharelistStock

SharelistScopes

Name	Type	Required	Description
is_self	boolean	false	Whether the current user is the creator
subscription	boolean	false	Whether the current user is subscribed