Create Sharelist

Create a new community stock list with an optional initial set of securities.

SDK Links

Python	longport.openapi.SharelistContext.create_sharelist
Rust	longport::sharelist::SharelistContext#create_sharelist
Go	SharelistContext.CreateSharelist
Node.js	SharelistContext#createSharelist

Parameters

SDK method parameters.

Name	Type	Required	Description
name	string	YES	Sharelist name
description	string	NO	Description
securities	string[]	NO	Initial list of security symbols, e.g. ["AAPL.US", "NVDA.US"]

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.create_sharelist(name="AI Picks", description="Top AI infrastructure stocks")
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.create_sharelist(name="AI Picks", description="Top AI infrastructure stocks")
    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.create_sharelist()
  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.getCreateSharelist().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.create_sharelist().await?;
    println!("{:?}", resp);
    Ok(())
}

#include <iostream>
#include <longport.hpp>

using namespace longport;
using namespace longport::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.create_sharelist([](auto resp) {
                if (resp) std::cout << "OK" << std::endl;
            });
        });
    std::cin.get();
}

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.CreateSharelist(context.Background())
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", resp)
}

Response

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "id": 15922
  }
}

Response Status

Status	Description	Schema
200	Success	CreateSharelistResponse
400	Bad request	None

Schemas

CreateSharelistResponse

Name	Type	Required	Description
id	int64	true	ID of the newly created sharelist