Short Positions (US & HK)

Get short interest data for US or HK securities. Market is auto-detected from the symbol suffix: .HK → HKEX short position data (daily); others → US FINRA short interest data (bi-monthly).

SDK Links

Python	longport.openapi.QuoteContext.short_positions
Rust	longport::quote::QuoteContext#short_positions
Go	QuoteContext.ShortPositions
Node.js	QuoteContext#shortPositions

Parameters

SDK method parameters.

Name	Type	Required	Description
symbol	string	YES	Security symbol, e.g. TSLA.US or 700.HK
count	integer	NO	Number of records to return (1–100, default: 20)

Request Example

from longport.openapi import QuoteContext, Config, OAuthBuilder

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

# US example
resp = ctx.short_positions("TSLA.US", 20)
print(resp)

# HK example
resp = ctx.short_positions("700.HK", 20)
print(resp)

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

    # US example
    resp = await ctx.short_positions("TSLA.US", 20)
    print(resp)

    # HK example
    resp = await ctx.short_positions("700.HK", 20)
    print(resp)

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

const { Config, QuoteContext, 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 = QuoteContext.new(config)
  const resp = await ctx.shortPositions('TSLA.US', 20)
  console.log(resp)
}
main().catch(console.error)

import com.longport.*;
import com.longport.quote.*;

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);
             QuoteContext ctx = QuoteContext.create(config)) {
            var resp = ctx.getShortPositions("TSLA.US", 20).get();
            System.out.println(resp);
        }
    }
}

use std::sync::Arc;
use longport::{oauth::OAuthBuilder, quote::QuoteContext, 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, _) = QuoteContext::new(config);
    let resp = ctx.short_positions("TSLA.US", 20).await?;
    println!("{:?}", resp);
    Ok(())
}

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

using namespace longport;
using namespace longport::quote;

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);
            QuoteContext ctx = QuoteContext::create(config);
            ctx.short_positions("TSLA.US", 20, [](auto resp) {
                if (resp) std::cout << resp->size() << 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/quote"
)

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

Response

Response Example

{
  "code": 0,
  "message": "success",
  "data": [
    {
      "timestamp": "2022-03-15T04:00:00Z",
      "current_shares_short": "111286790",
      "avg_daily_share_volume": "95077016",
      "days_to_cover": "1.17",
      "rate": "0.0068",
      "close": ""
    }
  ]
}

{
  "code": 0,
  "message": "success",
  "data": [
    {
      "timestamp": "2024-06-13T16:00:00Z",
      "amount": "53677721",
      "balance": "20386798436",
      "cost": "379.800",
      "rate": "0.0057"
    }
  ]
}

Response Status

Status	Description	Schema
200	Success	See schemas below
400	Bad request	None

Schemas

US Response (.US symbols)

Name	Type	Required	Description
data	object[]	false	Short position records
∟ timestamp	string	false	Settlement date (RFC 3339, e.g. 2022-03-15T04:00:00Z)
∟ current_shares_short	string	false	Number of shares sold short
∟ avg_daily_share_volume	string	false	Average daily share volume
∟ days_to_cover	string	false	Days to cover (short shares ÷ avg daily vol)
∟ rate	string	false	Short ratio
∟ close	string	false	Closing price for the day

HK Response (.HK symbols)

Name	Type	Required	Description
data	object[]	false	Short position records
∟ timestamp	string	false	Trade date (RFC 3339, e.g. 2022-03-15T04:00:00Z)
∟ amount	string	false	Short selling amount (HKD)
∟ balance	string	false	Short position balance
∟ cost	string	false	Closing price for the day
∟ rate	string	false	Short ratio