导入损益记录接口

接口概述

该接口用于批量导入损益记录到系统中，支持一次性导入多条损益记录数据。

• 请求方式：POST

• 请求 URL：https://openapi.elven.com/open/v3/transaction/gainLoss

请求头参数

参数名	类型	必填	说明
elven-api-key	String	是	分配给您的API密钥
elven-api-sign	String	是	请求签名，用于验证请求合法性
elven-api-timestamp	String	是	请求时间戳，毫秒级

查看详细说明

请求参数

Body 参数（JSON 格式）

参数名	类型	必填	说明
entityAccountId	String	是	账户的主键 ID
sourceId	String	是	Source 的主键 ID
timezone	String	否	时区，为空时视为 entity 时区。具体介绍
list	Array	是	包含多条损益记录的数组（每次最多支持 5000 条记录）

list 数组元素

参数名	类型	必填	说明
datetime	String	是	交易时间，格式为 YYYY-MM-DD HH:mm:ss
gainLossID	String	否	损益记录唯一标识
type	String	是	损益交易类型
positionSide	String	否	合约持仓方向（枚举值：LONG/SHORT）。仅在 type 为 FUTURE_REALIZED 或 FUTURE_UNREALIZED 时必填
asset	String	是	标的资产名称，最大 200 字符
gainLossAsset	String	是	收益（损失）计量的资产币种代码，需区分大小写，可从币种查询接口获取当前 entity 所支持的币种
gainLossAmount	Number	是	收益（损失）金额
memo	String	否	备注信息

type 参数说明

类型	说明
FUTURE_REALIZED	合约已实现收益（损失）
FUTURE_UNREALIZED	合约未实现收益（损失）
OPTIONS_REALIZED	期权已实现收益（损失）
OPTIONS_UNREALIZED	期权未实现收益（损失）

PositionSide 参数说明

type	positionSide 是否必填
FUTURE_REALIZED	必填（LONG/SHORT）
FUTURE_UNREALIZED	必填（LONG/SHORT）
OPTIONS_REALIZED	必须为空
OPTIONS_UNREALIZED	必须为空

请求示例

{
    "entityAccountId": "QfgBd6vH2ptevhqZjNTn06MiJOFUXGcD",
    "sourceId": "RHFjsy6UIgM1rdxvefXVsJy8L3NOhBmQ",
    "timezone": "UTC",
    "list": [
        {
            "datetime": "2024-08-01 15:59:00",
            "gainLossID": "123458",
            "type": "FUTURE_UNREALIZED",
            "asset": "ETHUSDT-PERP1",
            "positionSide": "LONG",
            "gainLossAsset": "USDT",
            "gainLossAmount": 500,
            "memo": ""
        },
        {
            "datetime": "2024-08-01 16:00:00",
            "gainLossID": "123459",
            "type": "FUTURE_REALIZED",
            "asset": "ETHUSDT-PERP1",
            "positionSide": "LONG",
            "gainLossAsset": "USDT",
            "gainLossAmount": 600,
            "memo": ""
        }
    ]
}

响应参数

参数名	类型	说明
status	String	请求状态（如 success）
data	Boolean	请求结果（如 true 表示成功）

响应示例

{
    "status": "success",
    "data": true
}

在线调试

您可以通过 Apifox 服务进行接口的在线调试：https://zswsuv3jhf.apifox.cn/api-253901227

注意事项

1. 异步处理：该接口调用成功后只是将数据导入到预处理数据库，系统需要一段时间来处理导入的损益记录数据，处理完成后才会显示在用户损益记录列表内。

2. 记录数量限制：每次请求最多支持导入 5000 条损益记录。

3. 数据完整性：请确保提供的交易数据完整且准确，避免因数据错误导致导入失败。

4. 时间格式：datetime 参数的格式必须严格按照 YYYY-MM-DD HH:mm:ss，否则可能导致解析错误。

5. 交易类型：type 参数必须选择正确的值，具体规则见上文。