API Reference
1. Info
- Title: gRPC API
- Version: 1.0.0
- Description: This documentation is generated from protobuf files using protoc-gen-doc.
2. Paths
EllipticBridge
EllipticBridge 服务定义,提供 KYA/KYT 风险查询与报告获取能力
GetKyaInfo
- Summary: 查询 KYA(了解您的客户)信息
- Method:
GetKyaInfo - Endpoint:
elliptic_bridge.EllipticBridge/GetKyaInfo - Request:
- Content-Type:
application/grpc - Schema: GetKyaInfoRequest
- Content-Type:
- Response:
- Content-Type:
application/grpc - Schema: GetKyaInfoResponse
- Content-Type:
GetKytInfo
- Summary: 查询 KYT(了解您的交易)信息
- Method:
GetKytInfo - Endpoint:
elliptic_bridge.EllipticBridge/GetKytInfo - Request:
- Content-Type:
application/grpc - Schema: GetKytInfoRequest
- Content-Type:
- Response:
- Content-Type:
application/grpc - Schema: GetKytInfoResponse
- Content-Type:
GetReportData
- Summary: 查询 KYA/KYT 报告详细数据
- Method:
GetReportData - Endpoint:
elliptic_bridge.EllipticBridge/GetReportData - Request:
- Content-Type:
application/grpc - Schema: GetReportDataRequest
- Content-Type:
- Response:
- Content-Type:
application/grpc - Schema: GetReportDataResponse
- Content-Type:
3. Components
3.1 Schemas
GetKyaInfoRequest
KYA 信息查询请求
| Field | Type | Description |
|---|---|---|
| address | string | 钱包地址 |
| blockchain | Blockchain | 区块链类型 |
GetKyaInfoResponse
KYA 信息查询响应
| Field | Type | Description |
|---|---|---|
| address | string | 钱包地址 |
| blockchain | string | 区块链名称 |
| riskScore | float | 风险分数(0-10,越高风险越大) |
| reportId | string | 报告ID |
| screeningId | string | 筛查ID(一次查询唯一) |
GetKytInfoRequest
KYT 信息查询请求
| Field | Type | Description |
|---|---|---|
| hash | string | 交易Hash |
| blockchain | Blockchain | 区块链类型 |
| outputAddress | string | 输出地址 |
| kytType | KytType | KYT类型 |
GetKytInfoResponse
KYT 信息查询响应
| Field | Type | Description |
|---|---|---|
| hash | string | 交易Hash |
| blockchain | string | 区块链名称 |
| outputAddress | string | 输出地址 |
| kytType | string | KYT类型 |
| riskScore | float | 风险分数 |
| reportId | string | 报告ID |
| screeningId | string | 筛查ID |
GetReportDataRequest
报告数据查询请求
| Field | Type | Description |
|---|---|---|
| reportId | string | 报告ID |
GetReportDataResponse
报告数据查询响应
| Field | Type | Description |
|---|---|---|
| reportId | string | 报告ID |
| hash | string | 地址或交易Hash |
| type | string | 类型(KYA/KYT) |
| source | string | 数据来源(如"elliptic") |
| fullText | string | 报告原文(JSON字符串) |
| riskScore | float | 风险分数 |
| updatedAt | int64 | 更新时间(Unix时间戳) |
3.2 Enums
Blockchain
区块链类型枚举,支持的链类型
| Name | Number | Description |
|---|---|---|
| HOLISTIC | 0 | 综合(默认/自动识别) |
| ALGORAND | 1 | Algorand |
| APTOS | 2 | Aptos |
| ARBITRUM | 3 | Arbitrum |
| AVALANCHE_CCHAIN | 4 | Avalanche (C-Chain) |
| BINANCE_CHAIN | 5 | Binance Chain |
| BINANCE_SMART_CHAIN | 6 | Binance Smart Chain |
| BITCOIN | 7 | 比特币 |
| CARDANO | 8 | Cardano |
| CELO | 9 | Celo |
| COSMOS | 10 | Cosmos |
| CRYPTO_DOT_COM | 11 | Crypto.com |
| DOGECOIN | 12 | Dogecoin |
| DYDX | 13 | dYdX |
| ETHEREUM | 14 | 以太坊 |
| ETHEREUM_CLASSIC | 15 | 以太坊经典 |
| FILECOIN | 16 | Filecoin |
| FANTOM | 17 | Fantom |
| FLARE | 18 | Flare |
| GNOSIS | 19 | Gnosis |
| HAQQ | 20 | HAQQ |
| HEDERA | 21 | Hedera |
| LITECOIN | 22 | 莱特币 |
| MOBILECOIN | 23 | MobileCoin |
| NEAR | 24 | Near |
| OPTIMISM | 25 | Optimism |
| POLKADOT | 26 | Polkadot |
| POLYGON | 27 | Polygon |
| RIPPLE | 28 | Ripple |
| SOLANA | 29 | Solana |
| STELLAR | 30 | Stellar |
| SUI | 31 | Sui |
| TEZOS | 32 | Tezos |
| TON | 33 | TON |
| TRON | 34 | Tron |
| ZILLIQA | 35 | Zilliqa |
| ZKSYNC | 36 | zkSync |
| BITCOINCASH | 37 | Bitcoin Cash |
| HORIZEN | 38 | Horizen |
| ZCASH | 39 | ZCash |
KytType
KYT 类型枚举
| Name | Number | Description |
|---|---|---|
| UNKNOW_TYPE | 0 | 未知类型 |
| SOURCE_OF_FUNDS | 1 | 资金来源 |
| DESTINATION_OF_FUNDS | 2 | 资金去向 |
4. Scalar Value Types
| Proto Type | Go Type | C++ Type | Java Type | Python Type | Notes |
|---|---|---|---|---|---|
| double | float64 | double | double | float | |
| float | float32 | float | float | float | |
| int32 | int32 | int32 | int | int | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. |
| int64 | int64 | int64 | long | int/long | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. |
| uint32 | uint32 | uint32 | int | int/long | Uses variable-length encoding. |
| uint64 | uint64 | uint64 | long | int/long | Uses variable-length encoding. |
| sint32 | int32 | int32 | int | int | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. |
| sint64 | int64 | int64 | long | int/long | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. |
| fixed32 | uint32 | uint32 | int | int | Always four bytes. More efficient than uint32 if values are often greater than 2^28. |
| fixed64 | uint64 | uint64 | long | int/long | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. |
| sfixed32 | int32 | int32 | int | int | Always four bytes. |
| sfixed64 | int64 | int64 | long | int/long | Always eight bytes. |
| bool | bool | bool | boolean | boolean | |
| string | string | string | String | str/unicode | A string must always contain UTF-8 encoded or 7-bit ASCII text. |
| bytes | []byte | string | ByteString | str | May contain any arbitrary sequence of bytes. |
