From 04ddfed86048069d74fd26ed51ab10e84de8796f Mon Sep 17 00:00:00 2001 From: "ivan.z-apx" Date: Fri, 5 Jun 2026 15:05:10 +0800 Subject: [PATCH 1/2] announcement --- announcement.md | 109 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 109 insertions(+) create mode 100644 announcement.md diff --git a/announcement.md b/announcement.md new file mode 100644 index 0000000..cf092be --- /dev/null +++ b/announcement.md @@ -0,0 +1,109 @@ +# Announcement API + +响应数据有 **1 分钟本地缓存**。 + +`title`、`subtitle`、`content` 根据请求头语言自动返回对应语言版本；语言含 `zh` 时返回中文，其次匹配精确语言，兜底返回英文 `en`。 + +--- + +## AnnouncementResp（公共响应字段） + +| 字段 | 类型 | 说明 | +|------|------|------| +| `id` | Long | 公告 ID | +| `category` | String | 分类，见下方枚举 | +| `title` | String | 标题 | +| `subtitle` | String | 副标题 | +| `content` | String | 正文内容 | +| `publishTime` | Date | 发布时间 | +| `jumpLink` | String | 跳转链接 | + +## category 枚举值 + +| 值 | 说明 | +|----|------| +| `ACTIVITY` | 活动公告 | +| `NEW_LISTING` | 新币上线 | +| `DELISTING` | 下架公告 | +| `UPDATES` | 更新公告 | + +--- + +## Public 接口 + +### GET `/v1/public/composite/ae/announcement/get` + +根据 ID 获取单条公告详情。 + +**请求参数** + +| 参数 | 类型 | 必填 | 说明 | +|------|------|------|------| +| `id` | Long | 是 | 公告 ID | + +**响应** `CommonRet` + +--- + +### POST `/v1/public/composite/ae/announcement/search` + +分页查询公告列表，支持按分类筛选。 + +**请求体** + +| 参数 | 类型 | 必填 | 说明 | +|------|------|------|------| +| `page` | Integer | 是 | 页码（从 1 开始） | +| `size` | Integer | 是 | 每页条数 | +| `category` | String | 否 | 公告分类，不传则返回所有分类 | + +**响应** `CommonRet>` + +| 字段 | 类型 | 说明 | +|------|------|------| +| `total` | Long | 总条数 | +| `rows` | List\ | 公告列表 | + +--- + +## Private 接口（需登录） + +### POST `/v1/private/composite/ae/announcement/search-direct` + +分页查询当前用户的定向公告。用户地址从登录态自动获取，无需传参。 + +**请求体** + +| 参数 | 类型 | 必填 | 说明 | +|------|------|------|------| +| `page` | Integer | 是 | 页码（从 1 开始） | +| `size` | Integer | 是 | 每页条数 | + +**响应** `CommonRet>` + +| 字段 | 类型 | 说明 | +|------|------|------| +| `total` | Long | 总条数 | +| `rows` | List\ | 公告列表 | + +--- + +### GET `/v1/private/composite/ae/announcement/direct-list` + +获取当前用户的定向公告列表（不分页）。 + +**响应** `CommonRet>` + +--- + +### GET `/v1/private/composite/ae/announcement/get-direct` + +根据 ID 获取当前用户的单条定向公告详情。 + +**请求参数** + +| 参数 | 类型 | 必填 | 说明 | +|------|------|------|------| +| `id` | Long | 是 | 公告 ID | + +**响应** `CommonRet` From bf2cef8720eccc5df3b75b15d4dad16b13a53e83 Mon Sep 17 00:00:00 2001 From: "ivan.z-apx" Date: Fri, 5 Jun 2026 15:20:37 +0800 Subject: [PATCH 2/2] announcement --- announcement-en.md | 140 +++++++++++++++++++++++++++++++++++++++++++++ announcement-zh.md | 140 +++++++++++++++++++++++++++++++++++++++++++++ announcement.md | 109 ----------------------------------- 3 files changed, 280 insertions(+), 109 deletions(-) create mode 100644 announcement-en.md create mode 100644 announcement-zh.md delete mode 100644 announcement.md diff --git a/announcement-en.md b/announcement-en.md new file mode 100644 index 0000000..dcd4f60 --- /dev/null +++ b/announcement-en.md @@ -0,0 +1,140 @@ +# Announcement API + +## AnnouncementResp (Common Response Fields) + +| Field | Type | Description | +|-------|------|-------------| +| `id` | Long | Announcement ID | +| `category` | String | Category, see enum values below | +| `title` | String | Title | +| `subtitle` | String | Subtitle | +| `content` | String | Body content | +| `publishTime` | Date | Publish time (Unix timestamp in milliseconds) | +| `jumpLink` | String | Detail page URL | + +## Category Enum Values + +| Value | Description | +|-------|-------------| +| `ACTIVITY` | Activity announcements | +| `NEW_LISTING` | New token listings | +| `DELISTING` | Delisting notices | +| `UPDATES` | Platform updates | + +--- + +## Public Endpoints + +### GET `/bapi/composite/v1/public/composite/ae/announcement/get` + +Retrieve a single announcement by ID. + +**Request Parameters** + +| Parameter | Type | Required | Description | +|-----------|------|----------|-------------| +| `id` | Long | Yes | Announcement ID | + +**Request Example** + +```bash +curl -X GET "https://www.asterdex.com/bapi/composite/v1/public/composite/ae/announcement/get?id=12345" +``` + +**Response Example** + +```json +{ + "code": "000000", + "message": null, + "data": { + "id": 12345, + "category": "NEW_LISTING", + "title": "AsterDex Will List XYZ Token", + "subtitle": "XYZ/USDT Trading Pair Now Available", + "content": "AsterDex is pleased to announce the listing of XYZ Token...", + "publishTime": 1717545600000, + "jumpLink": "https://www.asterdex.com/en/support/announcement/detail/12345" + }, + "success": true +} +``` + +--- + +### POST `/bapi/composite/v1/public/composite/ae/announcement/search` + +Paginated search for announcements with optional category filtering. + +**Request Body** + +| Parameter | Type | Required | Description | +|-----------|------|----------|-------------| +| `page` | Integer | Yes | Page number (starts from 1) | +| `size` | Integer | Yes | Number of items per page | +| `category` | String | No | Announcement category; returns all categories if omitted | + +**Request Examples** + +Fetch all categories, page 1, 10 items per page: + +```bash +curl -X POST "https://www.asterdex.com/bapi/composite/v1/public/composite/ae/announcement/search" \ + -H "Content-Type: application/json" \ + -d '{ + "page": 1, + "size": 10 + }' +``` + +Filter by category (new listings): + +```bash +curl -X POST "https://www.asterdex.com/bapi/composite/v1/public/composite/ae/announcement/search" \ + -H "Content-Type: application/json" \ + -d '{ + "page": 1, + "size": 10, + "category": "NEW_LISTING" + }' +``` + +**Response** `CommonRet>` + +| Field | Type | Description | +|-------|------|-------------| +| `total` | Long | Total number of records | +| `rows` | List\ | List of announcements | + +**Response Example** + +```json +{ + "code": "000000", + "message": null, + "data": { + "total": 128, + "rows": [ + { + "id": 12345, + "category": "NEW_LISTING", + "title": "AsterDex Will List XYZ Token", + "subtitle": "XYZ/USDT Trading Pair Now Available", + "content": "AsterDex is pleased to announce the listing of XYZ Token...", + "publishTime": 1717545600000, + "jumpLink": "https://www.asterdex.com/en/support/announcement/detail/12345" + }, + { + "id": 12344, + "category": "NEW_LISTING", + "title": "AsterDex Will List ABC Token", + "subtitle": "ABC/USDT Trading Pair Now Available", + "content": "AsterDex is pleased to announce the listing of ABC Token...", + "publishTime": 1717459200000, + "jumpLink": "https://www.asterdex.com/en/support/announcement/detail/12344" + } + ] + }, + "success": true +} +``` diff --git a/announcement-zh.md b/announcement-zh.md new file mode 100644 index 0000000..66330bc --- /dev/null +++ b/announcement-zh.md @@ -0,0 +1,140 @@ +# 公告 API + +## AnnouncementResp（公共响应字段） + +| 字段 | 类型 | 说明 | +|------|------|------| +| `id` | Long | 公告 ID | +| `category` | String | 分类，见下方枚举 | +| `title` | String | 标题 | +| `subtitle` | String | 副标题 | +| `content` | String | 正文内容 | +| `publishTime` | Date | 发布时间（毫秒时间戳） | +| `jumpLink` | String | 跳转链接 | + +## category 枚举值 + +| 值 | 说明 | +|----|------| +| `ACTIVITY` | 活动公告 | +| `NEW_LISTING` | 新币上线 | +| `DELISTING` | 下架公告 | +| `UPDATES` | 更新公告 | + +--- + +## Public 接口 + +### GET `/bapi/composite/v1/public/composite/ae/announcement/get` + +根据 ID 获取单条公告详情。 + +**请求参数** + +| 参数 | 类型 | 必填 | 说明 | +|------|------|------|------| +| `id` | Long | 是 | 公告 ID | + +**请求示例** + +```bash +curl -X GET "https://www.asterdex.com/bapi/composite/v1/public/composite/ae/announcement/get?id=12345" +``` + +**响应示例** + +```json +{ + "code": "000000", + "message": null, + "data": { + "id": 12345, + "category": "NEW_LISTING", + "title": "AsterDex Will List XYZ Token", + "subtitle": "XYZ/USDT Trading Pair Now Available", + "content": "AsterDex is pleased to announce the listing of XYZ Token...", + "publishTime": 1717545600000, + "jumpLink": "https://www.asterdex.com/en/support/announcement/detail/12345" + }, + "success": true +} +``` + +--- + +### POST `/bapi/composite/v1/public/composite/ae/announcement/search` + +分页查询公告列表，支持按分类筛选。 + +**请求体** + +| 参数 | 类型 | 必填 | 说明 | +|------|------|------|------| +| `page` | Integer | 是 | 页码（从 1 开始） | +| `size` | Integer | 是 | 每页条数 | +| `category` | String | 否 | 公告分类，不传则返回所有分类 | + +**请求示例** + +查询所有分类，第 1 页，每页 10 条： + +```bash +curl -X POST "https://www.asterdex.com/bapi/composite/v1/public/composite/ae/announcement/search" \ + -H "Content-Type: application/json" \ + -d '{ + "page": 1, + "size": 10 + }' +``` + +按分类筛选（新币上线）： + +```bash +curl -X POST "https://www.asterdex.com/bapi/composite/v1/public/composite/ae/announcement/search" \ + -H "Content-Type: application/json" \ + -d '{ + "page": 1, + "size": 10, + "category": "NEW_LISTING" + }' +``` + +**响应** `CommonRet>` + +| 字段 | 类型 | 说明 | +|------|------|------| +| `total` | Long | 总条数 | +| `rows` | List\ | 公告列表 | + +**响应示例** + +```json +{ + "code": "000000", + "message": null, + "data": { + "total": 128, + "rows": [ + { + "id": 12345, + "category": "NEW_LISTING", + "title": "AsterDex Will List XYZ Token", + "subtitle": "XYZ/USDT Trading Pair Now Available", + "content": "AsterDex is pleased to announce the listing of XYZ Token...", + "publishTime": 1717545600000, + "jumpLink": "https://www.asterdex.com/en/support/announcement/detail/12345" + }, + { + "id": 12344, + "category": "NEW_LISTING", + "title": "AsterDex Will List ABC Token", + "subtitle": "ABC/USDT Trading Pair Now Available", + "content": "AsterDex is pleased to announce the listing of ABC Token...", + "publishTime": 1717459200000, + "jumpLink": "https://www.asterdex.com/en/support/announcement/detail/12344" + } + ] + }, + "success": true +} +``` diff --git a/announcement.md b/announcement.md deleted file mode 100644 index cf092be..0000000 --- a/announcement.md +++ /dev/null @@ -1,109 +0,0 @@ -# Announcement API - -响应数据有 **1 分钟本地缓存**。 - -`title`、`subtitle`、`content` 根据请求头语言自动返回对应语言版本；语言含 `zh` 时返回中文，其次匹配精确语言，兜底返回英文 `en`。 - ---- - -## AnnouncementResp（公共响应字段） - -| 字段 | 类型 | 说明 | -|------|------|------| -| `id` | Long | 公告 ID | -| `category` | String | 分类，见下方枚举 | -| `title` | String | 标题 | -| `subtitle` | String | 副标题 | -| `content` | String | 正文内容 | -| `publishTime` | Date | 发布时间 | -| `jumpLink` | String | 跳转链接 | - -## category 枚举值 - -| 值 | 说明 | -|----|------| -| `ACTIVITY` | 活动公告 | -| `NEW_LISTING` | 新币上线 | -| `DELISTING` | 下架公告 | -| `UPDATES` | 更新公告 | - ---- - -## Public 接口 - -### GET `/v1/public/composite/ae/announcement/get` - -根据 ID 获取单条公告详情。 - -**请求参数** - -| 参数 | 类型 | 必填 | 说明 | -|------|------|------|------| -| `id` | Long | 是 | 公告 ID | - -**响应** `CommonRet` - ---- - -### POST `/v1/public/composite/ae/announcement/search` - -分页查询公告列表，支持按分类筛选。 - -**请求体** - -| 参数 | 类型 | 必填 | 说明 | -|------|------|------|------| -| `page` | Integer | 是 | 页码（从 1 开始） | -| `size` | Integer | 是 | 每页条数 | -| `category` | String | 否 | 公告分类，不传则返回所有分类 | - -**响应** `CommonRet>` - -| 字段 | 类型 | 说明 | -|------|------|------| -| `total` | Long | 总条数 | -| `rows` | List\ | 公告列表 | - ---- - -## Private 接口（需登录） - -### POST `/v1/private/composite/ae/announcement/search-direct` - -分页查询当前用户的定向公告。用户地址从登录态自动获取，无需传参。 - -**请求体** - -| 参数 | 类型 | 必填 | 说明 | -|------|------|------|------| -| `page` | Integer | 是 | 页码（从 1 开始） | -| `size` | Integer | 是 | 每页条数 | - -**响应** `CommonRet>` - -| 字段 | 类型 | 说明 | -|------|------|------| -| `total` | Long | 总条数 | -| `rows` | List\ | 公告列表 | - ---- - -### GET `/v1/private/composite/ae/announcement/direct-list` - -获取当前用户的定向公告列表（不分页）。 - -**响应** `CommonRet>` - ---- - -### GET `/v1/private/composite/ae/announcement/get-direct` - -根据 ID 获取当前用户的单条定向公告详情。 - -**请求参数** - -| 参数 | 类型 | 必填 | 说明 | -|------|------|------|------| -| `id` | Long | 是 | 公告 ID | - -**响应** `CommonRet`