Skip to content

fix(docs): update calendar finance_calendar code examples and add mis… #1125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
JetSquirrel wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix(docs): update calendar finance_calendar code examples and add mis… #1125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
61f0999
fix(docs): update calendar finance_calendar code examples and add mis…
Jun 30, 2026
7d95909
fix(docs): update longbridge cli finance calendar exmpale
Jun 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
138 changes: 82 additions & 56 deletions docs/en/docs/market/calendar/dividend_calendar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,52 +14,73 @@ Get upcoming and past dividend events including ex-date, pay date, and dividend

<CliCommand>
longbridge finance-calendar dividend
longbridge finance-calendar dividend --filter positions
longbridge finance-calendar dividend --market US
</CliCommand>

<SDKLinks module="calendar" klass="CalendarContext" method="finance_calendar" />


## Parameters

> **SDK method parameters.**

| Name | Type | Required | Description |
| ---- | ---- | -------- | ----------- |
| start | string | YES | Start date, YYYY-MM-DD |
| end | string | YES | End date, YYYY-MM-DD |
| market | string | NO | Market filter: `US`, `HK`, `SH`, `SZ`. Omit for all. |
| Name | Type | Required | Description |
| ------ | ------ | -------- | ---------------------------------------------------- |
| start | string | YES | Start date, YYYY-MM-DD |
| end | string | YES | End date, YYYY-MM-DD |
| market | string | NO | Market filter: `US`, `HK`, `SH`, `SZ`. Omit for all. |

## Request Example

<Tabs groupId="request-example">
<TabItem value="python" label="Python">

```python
from longbridge.openapi import CalendarContext, Config, OAuthBuilder
from longbridge.openapi import (
CalendarCategory,
CalendarContext,
Config,
OAuthBuilder,
)

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

resp = ctx.dividend_calendar("AAPL.US")
print(resp)
resp = ctx.finance_calendar(
CalendarCategory.Dividend, "2026-06-30", "2026-06-30", "US"
)

for group in resp.list:
for info in group.infos:
print(f" - {info.symbol:12} | {info.counter_name} | {info.date}")
```

</TabItem>
<TabItem value="python-async" label="Python (async)">

```python
import asyncio
from longbridge.openapi import AsyncCalendarContext, Config, OAuthBuilder
from longbridge.openapi import (
AsyncCalendarContext,
CalendarCategory,
Config,
OAuthBuilder,
)

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

resp = await ctx.dividend_calendar("AAPL.US")
print(resp)
resp = await ctx.finance_calendar(
CalendarCategory.Dividend, "2026-06-30", "2026-06-30", "US"
)

for group in resp.list:
for info in group.infos:
print(f" - {info.symbol:12} | {info.counter_name} | {info.date}")

if __name__ == "__main__":
asyncio.run(main())
Expand All @@ -69,15 +90,15 @@ if __name__ == "__main__":
<TabItem value="nodejs" label="Node.js">

```javascript
const { Config, CalendarContext, OAuth } = require('longbridge')
const { CalendarCategory, CalendarContext, Config, 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 = CalendarContext.new(config)
const resp = await ctx.dividend_calendar('AAPL.US')
const resp = await ctx.financeCalendar(CalendarCategory.Dividend, '2026-06-30', '2026-06-30', 'US')
console.log(resp)
}
main().catch(console.error)
Expand All @@ -95,7 +116,12 @@ class Main {
try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get();
Config config = Config.fromOAuth(oauth);
CalendarContext ctx = CalendarContext.create(config)) {
var resp = ctx.getDividendCalendar("AAPL.US").get();
FinanceCalendarOptions opts = new FinanceCalendarOptions();
opts.category = CalendarCategory.Dividend;
opts.start = "2026-06-30";
opts.end = "2026-06-30";
opts.market = "US";
var resp = ctx.getFinanceCalendar(opts).get();
System.out.println(resp);
}
}
Expand All @@ -107,14 +133,14 @@ class Main {

```rust
use std::sync::Arc;
use longbridge::{oauth::OAuthBuilder, calendar::CalendarContext, Config};
use longbridge::{oauth::OAuthBuilder, calendar::{CalendarCategory, CalendarContext}, 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 = CalendarContext::new(config);
let resp = ctx.dividend_calendar("AAPL.US").await?;
let resp = ctx.finance_calendar(CalendarCategory::Dividend, "2026-06-30", "2026-06-30", Some("US".to_string())).await?;
println!("{:?}", resp);
Ok(())
}
Expand All @@ -137,7 +163,7 @@ int main() {
if (!res) return;
Config config = Config::from_oauth(*res);
CalendarContext ctx = CalendarContext::create(config);
ctx.dividend_calendar("AAPL.US", [](auto resp) {
ctx.finance_calendar(CalendarCategory::Dividend, "2026-06-30", "2026-06-30", "US", [](auto resp) {
if (resp) std::cout << "OK" << std::endl;
});
});
Expand All @@ -156,9 +182,9 @@ import (
"fmt"
"log"

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

func main() {
Expand All @@ -176,7 +202,8 @@ func main() {
log.Fatal(err)
}
defer c.Close()
resp, err := c.DividendCalendar(context.Background(), "AAPL.US")
market := "US"
resp, err := c.FinanceCalendar(context.Background(), calendar.CalendarCategoryDividend, "2026-06-30", "2026-06-30", &market)
if err != nil {
log.Fatal(err)
}
Expand All @@ -189,18 +216,17 @@ func main() {

## Response


### Response Example

```json
{
"code": 0,
"message": "success",
"data": {
"date": "2026-04-30",
"date": "2026-06-30",
"list": [
{
"date": "2026-04-30",
"date": "2026-06-30",
"count": 275,
"infos": [
{
Expand All @@ -210,7 +236,7 @@ func main() {
"counter_name": "Apple Inc.",
"event_type": "",
"activity_type": "",
"date": "2026-05-14",
"date": "2026-06-30",
"datetime": "",
"content": "",
"star": 0,
Expand All @@ -230,51 +256,51 @@ func main() {

### Response Status

| Status | Description | Schema |
| ------ | ----------- | ------ |
| Status | Description | Schema |
| ------ | ----------- | ------------------------------------------------- |
| 200 | Success | [CalendarEventsResponse](#CalendarEventsResponse) |
| 400 | Bad request | None |
| 400 | Bad request | None |

## Schemas

### CalendarEventsResponse

<a id="CalendarEventsResponse"></a>

| Name | Type | Required | Description |
| ---- | ---- | -------- | ----------- |
| date | string | false | Response date |
| list | object[] | true | List of calendar date groups, see [CalendarDateGroup](#CalendarDateGroup) |
| Name | Type | Required | Description |
| ---- | -------- | -------- | ------------------------------------------------------------------------- |
| date | string | false | Response date |
| list | object[] | true | List of calendar date groups, see [CalendarDateGroup](#CalendarDateGroup) |

### CalendarDateGroup

<a id="CalendarDateGroup"></a>

| Name | Type | Required | Description |
| ---- | ---- | -------- | ----------- |
| date | string | true | Date |
| count | integer | false | Number of events on this date |
| infos | object[] | true | List of calendar events, see [CalendarEventInfo](#CalendarEventInfo) |
| Name | Type | Required | Description |
| ----- | -------- | -------- | -------------------------------------------------------------------- |
| date | string | true | Date |
| count | integer | false | Number of events on this date |
| infos | object[] | true | List of calendar events, see [CalendarEventInfo](#CalendarEventInfo) |

### CalendarEventInfo

<a id="CalendarEventInfo"></a>

| Name | Type | Required | Description |
| ---- | ---- | -------- | ----------- |
| id | string | false | Event ID |
| symbol | string | false | Security symbol |
| market | string | false | Market |
| counter_name | string | false | Security name |
| event_type | string | false | Event type |
| activity_type | string | false | Activity type |
| date | string | false | Event date |
| datetime | string | false | Event datetime |
| date_type | string | false | Date type |
| content | string | false | Event content description |
| currency | string | false | Currency |
| star | integer | false | Importance rating (1-3) |
| icon | string | false | Icon URL |
| chart_uid | string | false | Chart identifier |
| financial_market_time | string | false | Financial market time |
| data_kv | object[] | false | Key-value data pairs |
| Name | Type | Required | Description |
| --------------------- | -------- | -------- | ------------------------- |
| id | string | false | Event ID |
| symbol | string | false | Security symbol |
| market | string | false | Market |
| counter_name | string | false | Security name |
| event_type | string | false | Event type |
| activity_type | string | false | Activity type |
| date | string | false | Event date |
| datetime | string | false | Event datetime |
| date_type | string | false | Date type |
| content | string | false | Event content description |
| currency | string | false | Currency |
| star | integer | false | Importance rating (1-3) |
| icon | string | false | Icon URL |
| chart_uid | string | false | Chart identifier |
| financial_market_time | string | false | Financial market time |
| data_kv | object[] | false | Key-value data pairs |
Loading
Loading