创建告警

POST

https://api.cobre.co/v1/alerts

该 API 允许您为特定货币对创建 FX 汇率监控告警。创建告警时，只需提供货币对、条件类型（above、below 或 within_range）、汇率阈值以及到期日期。API 将返回已创建的告警对象，包含唯一标识符及活跃状态。

请参阅 FX Alerts

常见错误

设置了 max_rate 但未指定条件 above 或 within_range。

设置了 min_rate 但未指定条件 below 或 within_range。

使用了 usd/cop、cop/usd、usd/mxn、mxn/cop 以外的不支持货币对。

将 valid_until 设置为过去的日期，或未采用正确的 ISO 8601 格式。

创建告警前忘记订阅 alerts.fx_rate.triggered Webhook。

请求体中使用了 camelCase 字段名（请使用 snake_case：currency_pair、max_rate、min_rate）。

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🟢201Success

application/json

Bodyapplication/json

🟠409

Request Example

Shell

JavaScript

Java

Swift

cURL

高于阈值告警区间范围告警低于阈值告警

curl --location 'https://api.cobre.co/v1/alerts' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "type": "fx_rate",
    "alias": "Above Example",
    "metadata": {
        "condition": "above",
        "currency_pair": "usd/cop",
        "max_rate": 3500
    },
    "valid_until": "2026-05-17T04:00:00Z"
}'

Response Example

201 - 高于阈值响应

{
    "id": "alt_7vH5YA5CI4",
    "creator": "usr_68TbxU1Uif",
    "type": "fx_rate",
    "alias": "Above Example",
    "active_status": true,
    "metadata": {
        "condition": "above",
        "currency_pair": "usd/cop",
        "max_rate": 3500
    },
    "valid_until": "2026-05-17T04:00:00Z",
    "created_at": "2026-04-17T04:36:58Z",
    "updated_at": "2026-04-17T04:36:58Z"
}

Modified at 2026-05-20 21:31:19

列出所有可用事件

获取所有告警

创建告警

常见错误#

Request

Responses

常见错误