API 使用教程

首先，使用 starfish::facplfBasic::facplf_create_new_factor 接口来新建因子模块。新建成功，将会返回一个包含该因子模块的 id 的字典，可以通过这个 id 进行后续的编辑和运行。

例如，新建一个因子模块，属性、备注和标签均为空：

starfish::facplfBasic::facplf_create_new_factor(
  {
      "name": "apitest_factorModule1",
      "properties": "",
      "tags": "",
      "comment": ""
  }
)

返回结果为：

{"factor_id": d1d3c1e8-083e-781a-6f66-839acf3e5105}

在创建完一个新的因子模块或者需要对已有因子模块进行编辑时，可以使用 starfish::facplfBasic::facplf_edit_factor 接口来修改因子模块的基本属性或因子代码。

例如，对上一小节新建的因子模块进行编辑，可以写为：

starfish::facplfBasic::facplf_edit_factor({
    "factor_id": "d1d3c1e8-083e-781a-6f66-839acf3e5105",
    "name": "test_factor",
    "properties": "SQL",
    "tags": "test",
    "comment": "",
    "code": "def test_factor(price){return max(price)}"
})

使用 starfish::facplfBasic::facplf_get_factor_list 接口，可以查看已有的因子模块列表。返回值为字典，其中 items 的值为一个表格，包含了当前用户的所有因子模块 id、因子函数列表、因子模块名称、属性、标签、备注、运行记录数、创建时间、更新时间和创建者。

例如，运行该接口：

starfish::facplfBasic::facplf_get_factor_list()

返回结果如下图所示：

使用 starfish::facplfBasic::facplf_get_factor_detail 接口，可以查看因子模块的详细信息。包含因子模块 id、因子函数列表、因子模块名称、基本属性、运行记录数和因子模块代码等。用户可以使用这个接口来确认因子模块的具体详情。

例如，运行下面的接口，查看指定因子模块的详细信息：

starfish::facplfBasic::facplf_get_factor_detail({
    "factor_id": "d1d3c1e8-083e-781a-6f66-839acf3e5105"
})

返回结果如下图所示：

先运行use starfish::facplfRun，再调用 starfish::facplfRun::facplf_create_draft_test接口，可以运行指定的因子模块。例如：

use starfish::facplfRun
starfish::facplfRun::facplf_create_draft_test({
    "factors": [
        {
            "type": "private",
            "factor_id": "d1d3c1e8-083e-781a-6f66-839acf3e5105",
            "funcs": [
                "test_factor"
            ]
        }
    ],
    "factor_templates": [
        {
            "template_id": "440a4075-6903-0ffe-4365-434782e5801b",
            "template_params": [
                {
                    "name": "data",
                    "type": "db_tb_select",
                    "value": {
                        "database": "dfs://factor_test",
                        "table": "data"
                    }
                },
                {
                    "name": "factorName",
                    "type": "factor",
                    "value": NULL
                },
                {
                    "name": "startDate",
                    "type": "date",
                    "value": "2024.09.20"
                },
                {
                    "name": "endDate",
                    "type": "date",
                    "value": "2024.09.20"
                },
                {
                    "name": "securityidName",
                    "type": "string",
                    "value": "securityid"
                },
                {
                    "name": "tradetimeName",
                    "type": "string",
                    "value": "tradetime"
                },
                {
                    "name": "frequency",
                    "type": "string",
                    "value": "1m"
                }
            ]
        }
    ],
    "analysis": false
})

执行后，将会返回一个包含因子模块运行结果 id 的 dict：

{
    "tests": [
        "admin_apitest_factorModule2_apitest_6927068c_f7c0_7a84_627f_146261d813e8"
    ]
}

根据上一小节得到的因子模块运行结果 id，可以调用 starfish::facplfBasic::facplf_get_single_test_detail 接口，查看运行结果：

starfish::facplfBasic::facplf_get_single_test_detail({
"test_id": "admin_apitest_factorModule2_apitest_6927068c_f7c0_7a84_627f_146261d813e8"
})

返回结果是一个 dict，结构如下图所示：

首先，使用 starfish::facplfBasic::facplf_create_new_private_factor_template 接口来新建因子计算模板。新建成功，将会返回一个包含该因子计算模板的 id 的字典，可以通过这个 id 进行后续的编辑。

例如，新建一个因子计算模板，属性、备注和标签均为空：

starfish::facplfBasic::facplf_create_new_private_factor_template({
    "tags": "",
    "factor_properties": "",
    "name": "apitest_factorTemplate1",
    "comment": ""
})

返回结果为：

{"template_id": 623b9f8c-3933-23b4-d506-13bb3524c084}

在创建完一个新的因子计算模板或者需要对已有因子计算模板进行编辑时，可以使用 starfish::facplfBasic::facplf_edit_private_factor_template 接口来修改因子计算模板的基本属性或模板代码。

例如，对上一小节新建的因子计算模板进行编辑，可以写为：

starfish::facplfBasic::facplf_edit_private_factor_template({
    "tags": "SQL",
    "factor_properties": "",
    "template_id": "623b9f8c-3933-23b4-d506-13bb3524c084",
    "name": "apitest_factorTemplate2",
    "comment": "",
    "code": '
def apitest_factorTemplate2(data, startDate, endDate, factorName, oriName, 
tarName, tarValueName, securityidName, tradetimeName, frequency){
    // 该计算模板以SQL的方式调用因子模块代码，并进行group by分组
    // 找出因子函数所需参数
    syntax = (exec syntax from defs() where name = factorName)[0]
    parameter = syntax[1:(strlen(syntax)-1)].split(",")
    mapping = dict(parameter, parameter)

    // 列名映射
    ori = oriName.strReplace(" ","").split(",")
    tar = tarName.strReplace(" ","").split(",")
    mapping[tar] = ori
    param = mapping[parameter]

    // 生成元代码
    args = each(sqlCol, param)
    // 将指定值转成int型
    args[!isNull(int(param))] = dropna(int(param))

    // sql 元代码
    // 选择所有代码并进行因子计算
    tarValueNameVector = tarValueName.split(",")
    selects = (sqlColAlias(parseExpr("\'"+frequency+"\'"), `frequency),
    sqlColAlias(makeUnifiedCall(funcByName(factorName), args), tarValueNameVector))
    from_tb = data
    whereConditions = expr(startDate, <=, sqlCol(tradetimeName,date), <=, endDate)
    ret = sql(
        select = selects,
        from = from_tb,
        where = whereConditions,
        groupBy=[sqlCol(securityidName), sqlColAlias(
        parseExpr("interval("+ tradetimeName +","+ frequency+","+"\'none\'"+")"), 
        tradetimeName)],
        groupFlag = 1
    )
    return ret.eval()
}'
})

使用 starfish::facplfBasic::facplf_get_private_factor_template_list 接口，可以查看已有的因子计算模板列表。返回值为字典，其中 items 的值为一个表格，包含了当前用户的所有因子计算模板 id、因子计算模板名称、属性、标签、备注、创建时间、更新时间和创建者。

例如，运行该接口：

starfish::facplfBasic::facplf_get_private_factor_template_list()

返回结果如下图所示：

使用 starfish::facplfBasic::facplf_get_private_factor_template_detail 接口，可以查看因子计算模板的详细信息。包含因子计算模板 id、因子计算模板名称、基本属性和因子计算模板代码等。用户可以使用这个接口来确认因子计算模板的具体详情。

例如，运行下面的接口，查看指定因子计算模板的详细信息：

starfish::facplfBasic::facplf_get_private_factor_template_detail({
    "template_id": "623b9f8c-3933-23b4-d506-13bb3524c084"
})

返回结果如下图所示：

首先，使用 starfish::facplfBasic::facplf_create_new_analysis_template 接口来新建因子评价模板。新建成功，将会返回一个包含该因子评价模板的 id 的字典，可以通过这个 id 进行后续的编辑和运行。

starfish::facplfBasic::facplf_create_new_analysis_template({
    "name": "apitest_factorAnalysis",
    "tags": "IC",
    "comment": ""
})

返回结果为：

{"template_id": 858fed65-37fe-621c-76ba-e0c050b3a02f}

在创建完一个新的因子评价模板或者需要对已有的因子评价模板进行编辑时，可以使用 starfish::facplfBasic::facplf_edit_analysis_template 接口来修改因子评价模板的基本属性或模板代码。

例如，对上一小节新建的因子评价模板进行编辑，可以写为：

starfish::facplfBasic::facplf_edit_analysis_template({
    "template_id": "858fed65-37fe-621c-76ba-e0c050b3a02f",
    "name": "apitest_factorAnalysis",
    "tags": "IC",
    "comment": "",
    "code": "use alphalens\r\ndef apitest_factorAnalysis(factorData, originData, factorTimeCol, factorSecurityidCol, factorCol, originTimeCol, originSecurityidCol, originPriceCol){\r\n    factor = sql((sqlCol(factorTimeCol,,`date),sqlCol(factorSecurityidCol,,`asset), sqlCol(factorCol,,`factor)), factorData, orderBy=(sqlCol(factorTimeCol), sqlCol(factorSecurityidCol))).eval()\r\n    prices = sql(sqlCol(originPriceCol,last), originData, groupBy = (sqlCol(originTimeCol,date,`date), sqlCol(originSecurityidCol)), groupFlag = 2).eval()\r\n    factor_data = get_clean_factor_and_forward_returns(factor,prices,groupby=NULL,binning_by_group=false,quantiles=2,bins=NULL,periods=[1, 5, 10],filter_zscore=20,groupby_labels=NULL,max_loss=0.35,zero_aware=false,cumulative_returns=true)\r\n    return create_information_tear_sheet(factor_data, group_neutral=false, by_group=false)[`Information_Analysis]\r\n}"
})

使用 starfish::facplfBasic::facplf_analysis_template_list 接口，可以查看已有的因子评价模板列表。返回值为字典，其中 items 的值为一个表格，包含了当前用户的所有因子评价模板 id、因子评价模板名称、标签、是否为自定义模板、创建时间、更新时间、创建者、备注、运行记录数和模板代码。

例如，运行该接口：

starfish::facplfBasic::facplf_analysis_template_list()

返回结果如下图所示：

使用 starfish::facplfBasic::facplf_analysis_template_detail 接口，可以查看因子评价模板的详细信息。包含因子评价模板 id、因子评价模板名称、基本属性和因子评价模板代码等。用户可以使用这个接口来确认因子评价模板的具体详情。

例如，运行下面的接口，查看指定因子评价模板的详细信息：

starfish::facplfBasic::facplf_analysis_template_detail({
    "template_id": "858fed65-37fe-621c-76ba-e0c050b3a02f"
}) 

返回结果如下图所示：

先运行 use starfish::facplfRun，再调用 starfish::facplfRun::facplf_run_analysis 接口，可以运行指定的因子评价模板。例如：

use starfish::facplfRun

starfish::facplfRun::facplf_run_analysis({
    "type": 3,
    "analysis_template": {
        "template_id": "858fed65-37fe-621c-76ba-e0c050b3a02f",
        "template_params": [
            {
                "name": "factorData",
                "type": "db_tb_select",
                "value": {
                    "database": "dfs://factor_test",
                    "table": "result"
                }
            },
            {
                "name": "originData",
                "type": "db_tb_select",
                "value": {
                    "database": "dfs://factor_test",
                    "table": "data"
                }
            },
            {
                "name": "factorTimeCol",
                "type": "string",
                "value": "tradetime"
            },
            {
                "name": "factorSecurityidCol",
                "type": "string",
                "value": "securityid"
            },
            {
                "name": "factorCol",
                "type": "string",
                "value": "value"
            },
            {
                "name": "originTimeCol",
                "type": "string",
                "value": "tradetime"
            },
            {
                "name": "originSecurityidCol",
                "type": "string",
                "value": "securityid"
            },
            {
                "name": "originPriceCol",
                "type": "string",
                "value": "price"
            }
        ]
    }
})

执行后，将会返回一个包含评价作业 id 和评价任务 id 的 dict：

{
    "aly_job_id": [
        "admin_apitest_factorAnalysis_29998048_42a7_3b68_efba_9b9b37e284bd"
    ],
    "aly_task_id": "29998048-42a7-3b68-efba-9b9b37e284bd"
}

根据上一小节得到的因子评价作业 id，可以调用 starfish::facplfBasic::facplf_get_analysis_record_detail 接口，查看运行结果：

starfish::facplfBasic::facplf_get_analysis_record_detail({
    "analysis_record_id": 
      "admin_apitest_factorAnalysis_29998048_42a7_3b68_efba_9b9b37e284bd"
})

返回结果是一个 dict，结构如下图所示：

首先，使用 starfish::facplfBasic::facplf_create_new_strategy 接口来新建策略。新建成功，将会返回一个包含该策略的 id 的字典。可以通过这个 id 进行后续的编辑和运行。

例如，新建一个股票策略，数据类型为快照，以字典形式接受行情数据，备注和标签为空：

starfish::facplfBasic::facplf_create_new_strategy({
    "strategy_name": "APIDemo",
    "strategy_group": "stock",
    "data_type": 1,
    "msg_as_table": false,
    "tags": "",
    "comment": ""
})

返回结果为：

{"id": "45f4ee13-4555-4ce1-3c3f-4039c04d8f73"}

在创建完一个新的策略或者需要对已有策略编辑时，可以使用starfish::facplfBasic::facplf_save_strategy_code接口编写策略逻辑。具体来说，因为因子平台将策略函数分为 9 个函数：initialize, beforeTrading, onTick, onSnapshot, onBar, onOrder, onTrade, afterTrading, finalize，因此用户可以根据自己的策略代码进行分类编写为一个字典，然后传入此接口中。

例如，用下面的代码编写一个策略：

initialize = '
	//初始化回调函数
	print("initialize")
	//订阅快照行情的指标
	d=dict(STRING,ANY)
	d["timestamp"] = <timestamp>
	d["maxVolatility_1m"]=<lastPrice\\prevClosePrice-1>
	Backtest::subscribeIndicator(contextDict["engine"], "snapshot", d) 
'

beforeTrading = '
    ////每日盘前回调函数
    ////1、通过contextDict["tradeDate"]可以获取当日；
    print ("beforeTrading: "+contextDict["tradeDate"])
    //通过backtest::setUniverse可以更换当日股票池
    Backtest::setUniverse(contextDict["engine"],["000001.XSHE"])
'
finalize = ''
afterTrading = ''
onBar = ''
onOrder = ''
onSnapshot = '
	for( istock in msg.keys()){
		lastPrice=msg[istock]["offerPrice"][0]
		qty=msg[istock]["offerQty"][0]
		if (indicator[istock]["maxVolatility_1m"]>0.01){
			Backtest::submitOrder(contextDict["engine"], 
			(istock,contextDict["tradeTime"] , 5, lastPrice, qty, 1),"buy")
		}
	}
'
onTick = ''
onTrade = ''

code = dict(["initialize","beforeTrading","onTick","onBar","onSnapshot","onOrder",
  "onTrade","afterTrading","finalize"],
  [initialize,beforeTrading,onTick,onBar,onSnapshot,onOrder,onTrade,
  afterTrading,finalize])

param = dict(`id`code, ["45f4ee13-4555-4ce1-3c3f-4039c04d8f73", code])
starfish::facplfBasic::facplf_save_strategy_code(param)

使用 starfish::facplfBasic::facplf_get_strategy_list 接口，可以查看已有的策略列表。返回值为字典，其中 items 的值为一个表格，包含了当前用户的所有策略 id、策略名称、策略类型、数据类型、创建更新时间、备注和标签。

例如，运行该接口：

starfish::facplfBasic::facplf_get_strategy_list()

返回结果为：

{
    "total": 1,
    "items": [
        {
            "id": "45f4ee13-4555-4ce1-3c3f-4039c04d8f73",
            "strategy_name": "API_demo",
            "strategy_group": "stock",
            "data_type": 1,
            "msg_as_table": false,
            "create_time": "2024.10.22 15:16:38.207",
            "update_time": "2024.10.22 15:20:24.129",
            "comment": "",
            "tags": "",
            "creator": "admin",
            "run_record_count": 0
        }
    ]
}

使用 starfish::facplfBasic::facplf_get_backtest_detail 接口，可以查看策略的详细信息。包含策略名称、策略代码、基本属性、以及运行记录数等。用户可以使用这个接口来确认策略的具体详情。

例如，运行下面的接口，查看指定策略的详细信息：

starfish::facplfBasic::facplf_get_backtest_detail({
    "id": "45f4ee13-4555-4ce1-3c3f-4039c04d8f73"
})

返回结果如下图所示：

首先，使用 starfish::facplfBasic::facplf_create_strategy_setting 接口来新建回测预设。新建成功，将会返回一个包含该回测预设的 id 的字典。可以通过这个 id 进行后续的编辑和获取预设。

例如，新建一个股票策略的回测预设，数据类型为快照，以字典形式接受行情数据，备注和标签为空：

starfish::facplfBasic::facplf_create_strategy_setting({
    "name": "API_demo",
    "strategy_group": "stock",
    "data_type": 1,
    "type": 1,
    "tags": "",
    "comment": ""
})

返回结果为：

{"id": "9228ac2a-7de8-0903-e52b-013164c10fb6"}

在创建完一个新的回测预设或者需要对已有回测预设进行编辑时，可以使用starfish::facplfBasic::facplf_edit_strategy_setting 接口来编辑回测预设。具体来说，就是用字典构造好回测参数，然后添加到具体的回测预设中。

例如，为上一小节新建的回测预设设置参数，可以写为：

config = {
    "date": [
        [
            "2022.04.11",
            "2022.04.11"
        ]
    ],
    "cash": [
        100000000
    ],
    "commission": [
        0.00015
    ],
    "tax": [
        0.001
    ],
    "matchingMode": [],
    "benchmark": [],
    "frequency": [
        0
    ],
    "latency": [],
    "symbolList": [],
    "msgPartition": [],
    "orderBookMatchingRatio": [],
    "matchingRatio": [],
    "enableSubscriptionToTickQuotes": [],
    "outputQueuePosition": [],
    "configTables": [
        {
            "configure": false
        },
        {
            "configure": false
        }
    ],
    "msgTables": [
        {
            "configure": true,
            "tableName": "snapshot",
            "mode": "code",
            "code": '
colName=["symbol","symbolSource","timestamp","lastPrice","upLimitPrice",
"downLimitPrice","totalBidQty","totalOfferQty","bidPrice","bidQty","offerPrice",
"offerQty","signal","prevClosePrice"]
colType= ["STRING","STRING","TIMESTAMP","DOUBLE","DOUBLE","DOUBLE","LONG",
	"LONG","DOUBLE[]","LONG[]","DOUBLE[]","LONG[]","DOUBLE[]","DOUBLE"]
messageTable=table(10000000:0, colName, colType)

insert into messageTable values("000001.XSHE","XSHE",2022.04.11 10:10:00.000,7,15,
5,10000,10000,
arrayVector([10],[6.9, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1,6.0]),
arrayVector([10],[800,900,1000,1100,1200,1000,1000,1000,1000,1000]),
arrayVector([10],[7.1,7.2,7.3,7.4,7.5,7.6,7.7,7.8,7.9,8.0]),
arrayVector([10],[1000,1000,1000,1000,1000,1000,1000,1000,1000,1000]),,6.5)
insert into messageTable values("000001.XSHE","XSHE",
2022.04.11 10:10:03.000,7.5,15,5,10000,10000,
arrayVector([10],[7.4, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1,6.0]),
arrayVector([10],[800,900,1000,1100,1200,1000,1000,1000,1000,1000]),
arrayVector([10],[7.6,7.7,7.8,7.9,8.0,8.1,8.2,8.3,8.4,8.5]),
arrayVector([10],[1000,1000,1000,1000,1000,1000,1000,1000,1000,1000]),,7)

result = messageTable  
                '
        }
    ],
    "attribution": false
}


starfish: :facplfBasic: :facplf_edit_strategy_setting(dict(`id`config,
[
    "9228ac2a-7de8-0903-e52b-013164c10fb6", toStdJson(config)
]))

使用 starfish::facplfBasic::facplf_get_strategy_setting_list 接口，可以查看已有的回测预设列表。返回值为字典，其中 items 的值为一个表格，包含了当前用户的所有策略预设 id、预设名称、预设类型、策略类型、数据类型、创建更新时间、备注和标签。

例如，运行该接口：

starfish::facplfBasic::facplf_get_strategy_setting_list()

返回结果为：

{
    "items": [
        {
            "id": "9228ac2a-7de8-0903-e52b-013164c10fb6",
            "name": "API_demo",
            "strategy_group": "stock",
            "data_type": 1,
            "create_time": "2024.10.22 15:26:41.276",
            "update_time": "2024.10.22 15:37:04.979",
            "comment": "",
            "tags": "",
            "creator": "admin",
            "type": 1
        }
    ],
    "total": 1
}

使用 starfish::facplfBasic::facplf_get_strategy_setting_detail 接口，可以查看回测预设的详细信息。包含创建者、预设类型、基本属性、预设参数、策略类型、行情类型、预设名称和预设 id。用户可以使用这个接口来确认回测预设的具体详情。

例如，运行下面的接口，查看指定回测预设的详细信息：

starfish::facplfBasic::facplf_get_strategy_setting_detail({
    "id": "9228ac2a-7de8-0903-e52b-013164c10fb6"
})

返回结果如下图所示：

先运行 use starfish::facplfRun，再调用 starfish::facplfRun::facplf_run_backtest 接口，可以运行指定的历史回测。

例如，使用预设运行，将预设详情中的 config 转为字典：

use starfish::facplfRun

config = starfish::facplfBasic::facplf_get_strategy_setting_detail({
  "id": "9228ac2a-7de8-0903-e52b-013164c10fb6"
})
config  = fromStdJson(config["config"])
param = dict(`id`type`config, ["45f4ee13-4555-4ce1-3c3f-4039c04d8f73", 0, config])
starfish::facplfRun::facplf_run_backtest(param)

或者不使用预设，而是在运行是设定参数，可以参考 API 手册中的运行参数，例如：

use starfish::facplfRun

starfish::facplfRun::facplf_run_backtest({
    "id": "45f4ee13-4555-4ce1-3c3f-4039c04d8f73",
    "type": 0,
    "config": {
        "date": [
            [
                "2022.04.11",
                "2022.04.11"
            ]
        ],
        "cash": [
            1000000
        ],
        "commission": [
            0.00015
        ],
        "tax": [
            0.001
        ],
        "matchingMode": [],
        "benchmark": [],
        "frequency": [
            0
        ],
        "latency": [],
        "symbolList": [],
        "msgPartition": [],
        "orderBookMatchingRatio": [],
        "matchingRatio": [],
        "enableSubscriptionToTickQuotes": [],
        "outputQueuePosition": [],
        "configTables": [
            {
                "configure": false
            },
            {
                "configure": false
            }
        ],
        "msgTables": [
            {
                "configure": true,
                "tableName": "snapshot",
                "mode": "code",
                "code": '
colName=["symbol","symbolSource","timestamp","lastPrice","upLimitPrice",
"downLimitPrice","totalBidQty","totalOfferQty","bidPrice","bidQty","offerPrice",
"offerQty","signal","prevClosePrice"]
colType= ["STRING","STRING","TIMESTAMP","DOUBLE","DOUBLE","DOUBLE","LONG",
	"LONG","DOUBLE[]","LONG[]","DOUBLE[]","LONG[]","DOUBLE[]","DOUBLE"]
messageTable=table(10000000:0, colName, colType)

insert into messageTable values("000001.XSHE","XSHE",2022.04.11 10:10:00.000,7,15,
5,10000,10000,
arrayVector([10],[6.9, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1,6.0]),
arrayVector([10],[800,900,1000,1100,1200,1000,1000,1000,1000,1000]),
arrayVector([10],[7.1,7.2,7.3,7.4,7.5,7.6,7.7,7.8,7.9,8.0]),
arrayVector([10],[1000,1000,1000,1000,1000,1000,1000,1000,1000,1000]),,6.5)
insert into messageTable values("000001.XSHE","XSHE",
2022.04.11 10:10:03.000,7.5,15,5,10000,10000,
arrayVector([10],[7.4, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1,6.0]),
arrayVector([10],[800,900,1000,1100,1200,1000,1000,1000,1000,1000]),
arrayVector([10],[7.6,7.7,7.8,7.9,8.0,8.1,8.2,8.3,8.4,8.5]),
arrayVector([10],[1000,1000,1000,1000,1000,1000,1000,1000,1000,1000]),,7)

result = messageTable  
                '
            }
        ]
    }
})

执行后，将会返回一个包含历史回测运行结果 id 的 dict：

{"id": "eaafd1e4-242c-d648-e40a-c226e8752207"}

根据上一小节得到的历史回测运行结果 id，可以调用 starfish::facplfRun::facplf_get_backtest_result 接口，查看运行详情：

starfish::facplfRun::facplf_get_backtest_result({
    "id": "eaafd1e4-242c-d648-e40a-c226e8752207",
    "backtest_type": 1
})

返回结果是一个 dict，包含回测任务进度、策略id、策略类型、策略名称、行情类型、回测运行参数和回测子任务 job id 等。结构如下图所示：

需要注意的是，这个接口返回的是整个历史回测的运行详情，并没有具体结果。如果需要查看某个回测子任务的具体结果，需要根据子任务的 job id，调用下一小节的接口进行查看。

根据上一小节得到的历史回测子任务的 job id，可以调用 starfish::facplfBasic::facplf_get_single_backtest_result 接口，查看单个历史回测运行子任务的运行结果，如每日持仓、收益率等。

例如：

// 提取上一小节的历史回测子任务的 job id
job_id = starfish::facplfRun::facplf_get_backtest_result({
  "id": "eaafd1e4-242c-d648-e40a-c226e8752207","backtest_type": 1
}).jobs.job_id[0]

// 查看单个历史回测运行子任务的运行结果
starfish::facplfBasic::facplf_get_single_backtest_result(dict(["job_id"],[job_id]))

返回结果是一个 dict，结构如下图所示：

其中，result 包含了历史回测运行的所有结果表：

先运行 use starfish::facplfRun，再调用 starfish::facplfRun::facplf_run_real_time_backtest 接口，可以运行指定的实时回测。

例如，在运行时设定参数，运行指定的实时回测：

use starfish::facplfRun

config = {
    "date": [
        "2023.01.31",
        "2023.02.03"
    ],
    "cash": 10000000,
    "commission": 1.5,
    "tax": 0.0,
    "frequency": 0,
    "depth": 5
}

config["msgTables"] = {"streamTableName": "testData"}
config["configTables"] = [{"configure": true,"tableName": "basicInfo",
  "mode": "code","code": '
tb = select * from loadTable("dfs://Backtest", "future_minData")
symbol=distinct(tb.symbol)

result = table(symbol as symbol, take(100.,size(symbol)) as multiplier, 
take(0.2,size(symbol)) as marginRatio,take(0.01,size(symbol)) as tradeUnit, 
take(0.02,size(symbol)) as priceUnit, take(0.03,size(symbol)) as priceTick, 
take(1.5,size(symbol)) as commission, 
take(1,size(symbol)) as deliveryCommissionMode)
  '
}]

// 运行实时回测
starfish::facplfRun::facplf_run_real_time_backtest(dict(`id`type`run_params,
[
    "1a5d079b-eb10-9b7c-42e1-d356c1009fdf",
    0,config
]))

执行后，将会返回一个包含实时回测运行结果 id 的 dict：

{"id": 14afe87e-bc0c-e6f9-7f81-d0e6cbbb2cd8}

根据上一小节得到的实时回测运行结果 id，可以调用 starfish::facplfRun::facplf_get_backtest_result 接口，查看运行详情：

starfish::facplfRun::facplf_get_backtest_result({
  "id": "14afe87e-bc0c-e6f9-7f81-d0e6cbbb2cd8","backtest_type": 2
})

返回结果是一个 dict，包含回测子任务 job id、回测任务状态、任务开始时间、回测运行参数、行情类型、策略名称、策略类型、策略 id 等。结构如下图所示：

因为实时回测任务的结果为流表，如果想进一步查看这些结果流表，可以使用 starfish::facplfBasic::facplf_get_real_time_backtest_stream_tbs 接口。

例如，查看指定实时回测任务的流表名称：

starfish::facplfBasic::facplf_get_real_time_backtest_stream_tbs({
    "job_id": [
        "14afe87e-bc0c-e6f9-7f81-d0e6cbbb2cd8"
    ]
})

返回结果如下图所示，用户可以根据这些流表名称，实时地从对应流表中获取回测结果：