API 文档

返回单个车次的历史担当记录

按车次号分页查询历史担当记录,也就是“这趟车在过去每一天由哪个车组担当”。支持用时间范围过滤,也支持游标翻页。

返回 API 列表
get/api/v2/history/train/{trainCode}
可匿名访问api.history.train.read

场景

适用场景

这个接口适合用在什么地方?下面的场景可以帮你判断它是不是你要找的那个。

  • 做“某车次近期担当车组”的时间线展示。
  • 统计某趟车在一段时间内使用过哪些车型或车组。

问答

常见问题

接入时最常遇到的疑问,先看看这里能不能解答。

start 和 end 都留空会怎样?

表示不限制时间范围,从最早记录开始读到最新记录。想限定范围时,两个参数都传会更可靠。

为什么记录里只有 emuId 而不是车组编号?

车组编号放在 emuCodeMappings 里按 ID 查询,这样大量重复的车组编号只需要保存一次,响应体积更小。

扣费

扣费规则

items 表示本次响应实际返回的记录条数,按记录数计算后再应用最低扣费。

按本页返回条数计费,0.04 额度/条,向上取整,最低扣费额度为 1

实际扣费以响应头 x-api-cost 为准;请求失败时也可能触发最低扣费。

请求说明

参数

路径参数

trainCodestring 必填

要查询的车次号,例如 G2492、D2212 或 C2001。字母大小写都可以,服务端会做标准化处理。

示例:G2492

查询参数

startinteger

起始时间戳,单位是秒,包含边界。留空表示从最早记录开始。

示例:1786636800

endinteger

结束时间戳,单位是秒,包含边界。留空表示读到最新记录。

示例:1786723200

limitinteger

每一页最多返回多少条记录。不传时使用默认值 20;超过服务端配置上限(当前为 200)时会被自动截断。

示例:20

cursorstring

分页游标,格式为 serviceDay:id(例如 20678:1858368)。第一页不需要传,翻页时直接复用上一页响应里的 nextCursor。serviceDay 是按上海时间自 1970-01-01 起的天数(epoch day),不是日期字符串。

示例:20678:1858368

响应说明

状态码与响应格式

200

一页车次历史记录。

响应头

x-api-remainx-api-costRetry-After
application/jsonobject

响应结构

{
    "type": "object",
    "required": [
        "meta",
        "data"
    ],
    "properties": {
        "meta": {
            "type": "object",
            "required": true,
            "shape": {
                "type": "object",
                "required": [
                    "remain",
                    "cost"
                ],
                "properties": {
                    "remain": {
                        "type": "integer",
                        "required": true
                    },
                    "cost": {
                        "type": "integer",
                        "required": true
                    },
                    "retryAfter": {
                        "type": "integer"
                    }
                }
            }
        },
        "data": {
            "type": "object",
            "required": true,
            "shape": {
                "type": "object",
                "required": [
                    "cursor",
                    "limit",
                    "nextCursor",
                    "items"
                ],
                "properties": {
                    "trainCode": {
                        "type": "object",
                        "shape": {
                            "type": "object",
                            "required": [
                                "prefix",
                                "number"
                            ],
                            "properties": {
                                "prefix": {
                                    "type": "string",
                                    "required": true
                                },
                                "number": {
                                    "type": "integer",
                                    "required": true
                                }
                            }
                        }
                    },
                    "start": {
                        "type": "integer"
                    },
                    "end": {
                        "type": "integer"
                    },
                    "cursor": {
                        "type": "string",
                        "required": true
                    },
                    "limit": {
                        "type": "integer",
                        "required": true
                    },
                    "nextCursor": {
                        "type": "string",
                        "required": true
                    },
                    "items": {
                        "type": "array<object>",
                        "required": true,
                        "shape": {
                            "type": "array",
                            "items": {
                                "type": "object",
                                "required": [
                                    "id",
                                    "serviceDay",
                                    "emuId"
                                ],
                                "properties": {
                                    "id": {
                                        "type": "integer",
                                        "required": true
                                    },
                                    "serviceDay": {
                                        "type": "integer",
                                        "required": true
                                    },
                                    "timetableId": {
                                        "type": "integer"
                                    },
                                    "emuId": {
                                        "type": "integer",
                                        "required": true
                                    }
                                }
                            }
                        }
                    },
                    "emuCodeMappings": {
                        "type": "object",
                        "shape": {
                            "type": "object"
                        }
                    },
                    "timetableMappings": {
                        "type": "object",
                        "shape": {
                            "type": "object"
                        }
                    }
                }
            }
        }
    }
}

示例响应

{
    "ok": true,
    "data": {
        "trainCode": {
            "prefix": "G",
            "number": 512
        },
        "cursor": "",
        "limit": 2,
        "nextCursor": "20678:1858368",
        "items": [
            {
                "id": 1886130,
                "serviceDay": 20679,
                "timetableId": 5479,
                "emuId": 1540
            },
            {
                "id": 1858368,
                "serviceDay": 20678,
                "timetableId": 5479,
                "emuId": 1544
            }
        ],
        "emuCodeMappings": {
            "1540": "CR400BF-AZ-0518",
            "1544": "CR400BF-AZ-5253"
        },
        "timetableMappings": {
            "5479": {
                "startStation": "汉口",
                "endStation": "北京西",
                "startOffset": 47340,
                "endOffset": 66060
            }
        }
    },
    "error": ""
}
400

请求参数不合法:可能是日期格式、游标格式或 limit 不符合要求。

响应头

x-api-remainx-api-costRetry-After
application/jsonobject

响应结构

{
    "type": "object",
    "required": [
        "meta",
        "error"
    ],
    "properties": {
        "meta": {
            "type": "object",
            "required": true,
            "shape": {
                "type": "object",
                "required": [
                    "remain",
                    "cost"
                ],
                "properties": {
                    "remain": {
                        "type": "integer",
                        "required": true
                    },
                    "cost": {
                        "type": "integer",
                        "required": true
                    },
                    "retryAfter": {
                        "type": "integer"
                    }
                }
            }
        },
        "error": {
            "type": "object",
            "required": true,
            "shape": {
                "type": "object",
                "required": [
                    "code",
                    "message"
                ],
                "properties": {
                    "code": {
                        "type": "string",
                        "required": true
                    },
                    "message": {
                        "type": "string",
                        "required": true
                    }
                }
            }
        }
    }
}

示例响应

{
    "meta": {
        "remain": 159,
        "cost": 1
    },
    "error": {
        "code": "invalid_param",
        "message": "date 必须使用 YYYYMMDD 格式。"
    }
}
401

请求未携带有效的认证信息,或提供的 API Key 已失效。

响应头

x-api-remainx-api-costRetry-After
application/jsonobject

响应结构

{
    "type": "object",
    "required": [
        "meta",
        "error"
    ],
    "properties": {
        "meta": {
            "type": "object",
            "required": true,
            "shape": {
                "type": "object",
                "required": [
                    "remain",
                    "cost"
                ],
                "properties": {
                    "remain": {
                        "type": "integer",
                        "required": true
                    },
                    "cost": {
                        "type": "integer",
                        "required": true
                    },
                    "retryAfter": {
                        "type": "integer"
                    }
                }
            }
        },
        "error": {
            "type": "object",
            "required": true,
            "shape": {
                "type": "object",
                "required": [
                    "code",
                    "message"
                ],
                "properties": {
                    "code": {
                        "type": "string",
                        "required": true
                    },
                    "message": {
                        "type": "string",
                        "required": true
                    }
                }
            }
        }
    }
}

示例响应

{
    "meta": {
        "remain": 159,
        "cost": 1
    },
    "error": {
        "code": "invalid_api_key",
        "message": "API Key 无效或已过期。"
    }
}
403

当前凭证缺少调用该接口所需的 scope。

响应头

x-api-remainx-api-costRetry-After
application/jsonobject

响应结构

{
    "type": "object",
    "required": [
        "meta",
        "error"
    ],
    "properties": {
        "meta": {
            "type": "object",
            "required": true,
            "shape": {
                "type": "object",
                "required": [
                    "remain",
                    "cost"
                ],
                "properties": {
                    "remain": {
                        "type": "integer",
                        "required": true
                    },
                    "cost": {
                        "type": "integer",
                        "required": true
                    },
                    "retryAfter": {
                        "type": "integer"
                    }
                }
            }
        },
        "error": {
            "type": "object",
            "required": true,
            "shape": {
                "type": "object",
                "required": [
                    "code",
                    "message"
                ],
                "properties": {
                    "code": {
                        "type": "string",
                        "required": true
                    },
                    "message": {
                        "type": "string",
                        "required": true
                    }
                }
            }
        }
    }
}

示例响应

{
    "meta": {
        "remain": 159,
        "cost": 1
    },
    "error": {
        "code": "forbidden",
        "message": "缺少调用该接口所需的权限。"
    }
}
429

额度不足或请求过于频繁,建议等 Retry-After 提示的时间后再试。

响应头

x-api-remainx-api-costRetry-After
application/jsonobject

响应结构

{
    "type": "object",
    "required": [
        "meta",
        "error"
    ],
    "properties": {
        "meta": {
            "type": "object",
            "required": true,
            "shape": {
                "type": "object",
                "required": [
                    "remain",
                    "cost"
                ],
                "properties": {
                    "remain": {
                        "type": "integer",
                        "required": true
                    },
                    "cost": {
                        "type": "integer",
                        "required": true
                    },
                    "retryAfter": {
                        "type": "integer"
                    }
                }
            }
        },
        "error": {
            "type": "object",
            "required": true,
            "shape": {
                "type": "object",
                "required": [
                    "code",
                    "message"
                ],
                "properties": {
                    "code": {
                        "type": "string",
                        "required": true
                    },
                    "message": {
                        "type": "string",
                        "required": true
                    }
                }
            }
        }
    }
}

示例响应

{
    "meta": {
        "remain": 159,
        "cost": 1
    },
    "error": {
        "code": "rate_limited",
        "message": "额度不足,请稍后再试。"
    }
}