Pause DCA Plan

Temporarily pause a DCA plan. The plan can be resumed later.

CLI

longbridge dca pause 12345

SDK Links

Python	longbridge.openapi.DCAContext.pause
Rust	longbridge::dca::DCAContext#pause
Go	DCAContext.Pause
Node.js	DCAContext#pause
Java	DCAContext.getPause
C++	longbridge::dca::DCAContext::pause

Parameters

Name	Type	Required	Description
plan_id	string	YES	DCA plan ID

Request Example

from longbridge.openapi import DCAContext, Config, OAuthBuilder

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

ctx.pause("12345")

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

    await ctx.pause("12345")

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

const { Config, DCAContext, 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 = DCAContext.new(config)
  await ctx.pause('12345')
}
main().catch(console.error)

import com.longbridge.*;
import com.longbridge.dca.*;

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);
             DCAContext ctx = DCAContext.create(config)) {
            ctx.pause("12345").get();
        }
    }
}

use std::sync::Arc;
use longbridge::{oauth::OAuthBuilder, dca::DCAContext, 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 = DCAContext::new(config);
    ctx.pause("12345").await?;
    Ok(())
}

package main

import (
	"context"
	"fmt"
	"log"

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

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 := dca.NewFromCfg(conf)
	if err != nil {
		log.Fatal(err)
	}
	defer c.Close()
	if err := c.Pause(context.Background(), "12345"); err != nil {
		log.Fatal(err)
	}
}

Response

Response Example

{
  "code": 0,
  "message": "success"
}

Response Status

Status	Description	Schema
200	Success	None
400	Bad request	None