Windvane

https://windvane.lichoin.com/docs-api
Admin
Windvane is a cybersecurity intelligence and asset reconnaissance platform that provides APIs for...
Tokens:4,705
Snippets:30
Trust Score:5.1
Update:1 month ago
Show doc for...
Tokens:
Raw
### Call Example for GetFrequency

Source: https://windvane.lichoin.com/docs-api

Example request for the /GetFrequency endpoint including required headers.

```http
POST {{BaseUrl}}/GetFrequency
Content-Type: application/json
X-Api-Key: 4b7f68b1-xxxx-xxxx-xxxx-xxx...xxx

{

}
```

--------------------------------

### Example Subdomain Query Request

Source: https://windvane.lichoin.com/docs-api

An example HTTP POST request for the ListDomainWhois endpoint including headers and JSON body.

```http
POST {{BaseUrl}}/ListDomainWhois
Content-Type: application/json
X-Api-Key: 4b7f68b1-xxxx-xxxx-xxxx-xxx...xxx

{
  "domain": "baidu.com",
  "page_request": {
    "page": 1,
    "count": 30
  }
}
```

--------------------------------

### Successful Response Example

Source: https://windvane.lichoin.com/docs-api

JSON response structure returned upon a successful request.

```json
{
    "code": 0,
    "msg": "success",
    "data": {
        "frequency": "25" //已经消耗的次数
        "limitcount": "2000000" // 总的次数
    },
    "server_time": "2025-08-08T20:01:58+08:00",
    "version": "v0.0.1"
}
```

--------------------------------

### DNS History API Responses

Source: https://windvane.lichoin.com/docs-api

Example JSON responses for successful and failed DNS history queries.

```json
{
    "code": 0,
    "msg": "success",
    "data": {
        "list": [
            {
                "domain": "baidu.com",
                "answer": "182.xx.xxx.xxx",
                "answer_type": "A",
                "last_updated_at": "2025-06-25T09:55:06Z",
                "uuid": ""
            },
            ...
            ...
            ...
        ],
        "page_info": {
            "total": "15",
            "count": "30",
            "total_page": "1"
        }
    },
    "server_time": "2025-08-07T17:28:06+08:00",
    "version": "v0.0.1"
}
```

```json
{
    "code": 1211003,//code 不为0
    "msg": "Request unknown error",
    "data": null,
    "server_time": "2025-08-08T17:14:10+08:00",
    "version": "v0.0.1"
}
```

--------------------------------

### Domain Whois History API Responses

Source: https://windvane.lichoin.com/docs-api

Example JSON responses for successful and failed Whois history queries.

```json
{
    "code": 0,
    "msg": "success",
    "data": {
        "list": [
            {
                "last_updated_at": "2025-06-25T19:51:05Z",
                "domain": "baidu.com",
                "creation_date": "1999-10-11T03:05:17Z",
                "updated_date": "2025-04-07T16:48:16Z",
                "expiration_date": "2028-10-11T03:05:17Z",
                "registrar_url": "http://www.markmonitor.com",
                "registrant_name": "",
                "registrant_organization": "北京百度网讯科技有限公司",
                "registrant_street": "",
                "registrant_city": "",
                "registrant_state": "Beijing",
                "registrant_email": "select request email form at https://domains.markmonitor.com/whois/baidu.com",
                "uuid": ""
            }
            ...
            ...
            ...
        ],
        "page_info": {
            "total": "3",
            "count": "30",
            "total_page": "1"
        }
    },
    "server_time": "2025-08-07T17:30:37+08:00",
    "version": "v0.0.1"
}
```

```json
{
    "code": 1211003,//code 不为0
    "msg": "Request unknown error",
    "data": null,
    "server_time": "2025-08-07T17:31:52+08:00",
    "version": "v0.0.1"
}
```

--------------------------------

### MatchMode Enumeration

Source: https://windvane.lichoin.com/docs-api

Defines the matching strategies available for queries.

```protobuf
// 匹配方式
enum MatchMode {
  MATCH_MODE_EXACT = 1; // 精确匹配
  MATCH_MODE_FUZZY = 2; // 模糊匹配
}
```

--------------------------------

### LinkMethod Enumeration

Source: https://windvane.lichoin.com/docs-api

Defines the various methods used for establishing links between entities.

```protobuf
// 关联方式
enum LinkMethod {
  // 注册组织
  LINK_METHOD_WHOIS_REGISTRANT_ORG = 1;
  // 注册名
  LINK_METHOD_WHOIS_REGISTRANT_NAME = 2;
  // 注册email
  LINK_METHOD_WHOIS_REGISTRANT_EMAIL = 3;
  // A记录
  LINK_METHOD_DNS_A_RECORD = 4;
  // MX记录
  LINK_METHOD_DNS_MX_RECORD = 5;
  // CNAME记录
  LINK_METHOD_DNS_CNAME_RECORD = 6;
  // 证书CN
  LINK_METHOD_CTLOG_SUBJECT_CN = 7;
  // 证书组织
  LINK_METHOD_CTLOG_SUBJECT_O = 8;
  // 证书SHA256
  LINK_METHOD_CTLOG_SHA256 = 9;
  // 证书公钥
  LINK_METHOD_CTLOG_PUBLICKEY = 10;
  // 相似域名
  LINK_METHOD_SIM_DOMAIN_NAME = 11;
  // 图标
  LINK_METHOD_ICON_HASH = 12;
}
```

--------------------------------

### POST /ListDomainWhois

Source: https://windvane.lichoin.com/docs-api

Retrieves the historical Whois registration information for a specified domain.

```APIDOC
## POST /ListDomainWhois

### Description
Retrieves the historical Whois registration information for a specified domain.

### Method
POST

### Endpoint
/ListDomainWhois

### Parameters
#### Request Body
- **domain** (string) - Required - The domain to query.
- **page_request** (object) - Required - Pagination settings containing 'page' and 'count' (max 1000).

### Request Example
{
  "domain": "baidu.com",
  "page_request": {
    "page": 1,
    "count": 30
  }
}

### Response
#### Success Response (200)
- **code** (integer) - Status code (0 for success).
- **msg** (string) - Status message.
- **data** (object) - Contains the list of Whois records and page_info.

#### Response Example
{
    "code": 0,
    "msg": "success",
    "data": {
        "list": [
            {
                "last_updated_at": "2025-06-25T19:51:05Z",
                "domain": "baidu.com",
                "creation_date": "1999-10-11T03:05:17Z",
                "updated_date": "2025-04-07T16:48:16Z",
                "expiration_date": "2028-10-11T03:05:17Z",
                "registrant_organization": "北京百度网讯科技有限公司",
                "registrant_state": "Beijing"
            }
        ],
        "page_info": {
            "total": "3",
            "count": "30",
            "total_page": "1"
        }
    },
    "server_time": "2025-08-07T17:30:37+08:00",
    "version": "v0.0.1"
}
```

--------------------------------

### EntityType Enumeration

Source: https://windvane.lichoin.com/docs-api

Defines the types of entities supported by the system.

```protobuf
// 实体类型
enum EntityType {
  // 组织
  ENTITY_TYPE_ORGANIZATION = 1;
  // 资产
  ENTITY_TYPE_ASSET = 2;
  // 个人
  ENTITY_TYPE_PERSON = 3;
}
```

--------------------------------

### POST /ListSubDomain

Source: https://windvane.lichoin.com/docs-api

Queries subdomains for a specified domain with pagination support.

```APIDOC
## POST /ListSubDomain

### Description
Queries subdomains for a given domain. Requires an API key for full access, otherwise limited to 5 requests.

### Method
POST

### Endpoint
https://windvane.lichoin.com/trpc.backendhub.public.WindvaneService/ListSubDomain

### Parameters
#### Query Parameters
- **X-Api-Key** (string) - Optional - User permanent API key.

#### Request Body
- **domain** (string) - Required - The domain to query.
- **page_request** (object) - Required - Pagination settings containing 'page' and 'count' (max 1000).

### Request Example
{
  "domain": "baidu.com",
  "page_request": {
    "page": 1,
    "count": 30
  }
}

### Response
#### Success Response (200)
- **code** (integer) - Status code (0 for success).
- **msg** (string) - Status message.
- **data** (object) - Contains the list of subdomains and page_response details.

#### Response Example
{
    "code": 0,
    "msg": "success",
    "data": {
        "list": [
            {
                "last_updated_at": "2025-06-13T10:10:21Z",
                "domain": "test.baidu.com",
                "uuid": ""
            }
        ],
        "page_response": {
            "total": "5337",
            "count": "30",
            "total_page": "178"
        }
    },
    "server_time": "2025-08-07T16:04:43+08:00",
    "version": "v0.0.1"
}
```

--------------------------------

### Define Subdomain Query Endpoint

Source: https://windvane.lichoin.com/docs-api

The endpoint path for querying subdomains.

```text
POST: /ListSubDomain
```

--------------------------------

### POST /ListDNS

Source: https://windvane.lichoin.com/docs-api

Retrieves the historical DNS resolution records for a specified domain.

```APIDOC
## POST /ListDNS

### Description
Retrieves the historical DNS resolution records for a specified domain.

### Method
POST

### Endpoint
/ListDNS

### Parameters
#### Request Body
- **domain** (string) - Required - The domain to query.
- **page_request** (object) - Required - Pagination settings containing 'page' and 'count' (max 1000).

### Request Example
{
  "domain": "baidu.com",
  "page_request": {
    "page": 1,
    "count": 30
  }
}

### Response
#### Success Response (200)
- **code** (integer) - Status code (0 for success).
- **msg** (string) - Status message.
- **data** (object) - Contains the list of DNS records and page_info.

#### Response Example
{
    "code": 0,
    "msg": "success",
    "data": {
        "list": [
            {
                "domain": "baidu.com",
                "answer": "182.xx.xxx.xxx",
                "answer_type": "A",
                "last_updated_at": "2025-06-25T09:55:06Z",
                "uuid": ""
            }
        ],
        "page_info": {
            "total": "15",
            "count": "30",
            "total_page": "1"
        }
    },
    "server_time": "2025-08-07T17:28:06+08:00",
    "version": "v0.0.1"
}
```

--------------------------------

### POST /SearchLinks

Source: https://windvane.lichoin.com/docs-api

Performs a reverse lookup to find similar domain information.

```APIDOC
## POST /SearchLinks

### Description
Performs a reverse lookup to find similar domain information based on provided criteria.

### Method
POST

### Endpoint
/SearchLinks

### Parameters
#### Request Body
- **link_method** (integer) - Required - LinkMethod identifier.
- **link_type** (array) - Required - List of EntityType identifiers.
- **query_str** (string) - Required - The domain to check for similarity.
- **mode** (integer) - Required - MatchMode identifier.
- **page_request** (object) - Required - Pagination settings containing "page" and "count" (max 1000).

### Request Example
{
    "query_str": "baidu.com",
    "link_type": [1, 2, 3],
    "link_method": 1
}

### Response
#### Success Response (200)
- **code** (integer) - Status code (0 for success).
- **msg** (string) - Status message.
- **data** (object) - Contains the list of similar domains with similarity scores.

#### Response Example
{
    "code": 0,
    "msg": "success",
    "data": {
        "list": [
            {
                "domain": "baidu.zj.cn",
                "score": "1.00",
                "uuid": ""
            }
        ]
    },
    "server_time": "2025-08-08T10:33:02+08:00",
    "version": "v0.0.1"
}
```

--------------------------------

### POST /ListEmail

Source: https://windvane.lichoin.com/docs-api

Queries email addresses associated with a specific domain suffix.

```APIDOC
## POST /ListEmail

### Description
Queries email addresses associated with a specific domain suffix.

### Method
POST

### Endpoint
/ListEmail

### Parameters
#### Request Body
- **email** (string) - Required - The domain suffix to query.
- **page_request** (object) - Required - Pagination settings containing "page" and "count" (max 1000).

### Request Example
{
  "email": "baidu.com",
  "page_request": {
    "page": 1,
    "count": 30
  }
}

### Response
#### Success Response (200)
- **code** (integer) - Status code (0 for success).
- **msg** (string) - Status message.
- **data** (object) - Contains the list of emails and page_response metadata.

#### Response Example
{
    "code": 0,
    "msg": "success",
    "data": {
        "list": [
            {
                "email": "xxxxxxxxxxxx@baidu.com",
                "uuid": ""
            }
        ],
        "page_response": {
            "total": "2897",
            "count": "30",
            "total_page": "97"
        }
    },
    "server_time": "2025-08-08T10:29:18+08:00",
    "version": "v0.0.1"
}
```

--------------------------------

### Define Base URL

Source: https://windvane.lichoin.com/docs-api

The base URL for all Windvane service API requests.

```text
BaseUrl: https://windvane.lichoin.com/trpc.backendhub.public.WindvaneService
```

--------------------------------

### POST /GetFrequency

Source: https://windvane.lichoin.com/docs-api

Retrieves the user's remaining free query frequency and total limit count.

```APIDOC
## POST /GetFrequency

### Description
Retrieves the user's remaining free query frequency and total limit count.

### Method
POST

### Endpoint
/GetFrequency

### Request Example
{

}

### Response
#### Success Response (200)
- **code** (integer) - Status code
- **msg** (string) - Status message
- **data** (object) - Contains frequency and limitcount
- **server_time** (string) - Server timestamp
- **version** (string) - API version

#### Response Example
{
    "code": 0,
    "msg": "success",
    "data": {
        "frequency": "25",
        "limitcount": "2000000"
    },
    "server_time": "2025-08-08T20:01:58+08:00",
    "version": "v0.0.1"
}
```

--------------------------------

### Reverse Domain Information Lookup

Source: https://windvane.lichoin.com/docs-api

Endpoint for searching similar domain information based on provided criteria.

```http
POST: /SearchLinks
```

```http
POST {{BaseUrl}}/SearchLinks
Content-Type: application/json
X-Api-Key: 4b7f68b1-xxxx-xxxx-xxxx-xxx...xxx

{
    "query_str": "baidu.com",
    "link_type": [
        1,
        2,
        3
    ],
    "link_method": 1
}
```

```json
{
    "code": 0,
    "msg": "success",
    "data": {
        "list": [
            {
                "domain": "baidu.zj.cn",
                "score": "1.00",// 相似度0-1,1最高
                "uuid": ""
            },
           ...
           ...
           ...
        ]
    },
    "server_time": "2025-08-08T10:33:02+08:00",
    "version": "v0.0.1"
}
```

```json
{
    "code": 1211003,//code 不为0
    "msg": "Request unknown error",
    "data": null,
    "server_time": "2025-08-08T17:14:10+08:00",
    "version": "v0.0.1"
}
```

--------------------------------

### Successful API Response

Source: https://windvane.lichoin.com/docs-api

The structure of a successful API response containing the requested data.

```json
{
    "code": 0,
    "msg": "success",
    "data": {
        "list": [
            {
                "last_updated_at": "2025-06-13T10:10:21Z",
                "domain": "test.baidu.com",
                "uuid": ""
            },
            ...
            ...
            ...
        ],
        "page_response": {
            "total": "5337",
            "count": "30",
            "total_page": "178"
        }
    },
    "server_time": "2025-08-07T16:04:43+08:00",
    "version": "v0.0.1"
}
```

--------------------------------

### Query Email Domain

Source: https://windvane.lichoin.com/docs-api

Endpoint for retrieving email lists associated with a specific domain suffix.

```http
POST: /ListEmail
```

```http
POST {{BaseUrl}}/ListEmail
Content-Type: application/json
X-Api-Key: 4b7f68b1-xxxx-xxxx-xxxx-xxx...xxx

{
  "email": "baidu.com",
  "page_request": {
    "page": 1,
    "count": 30
  }
}
```

```json
{
    "code": 0,
    "msg": "success",
    "data": {
        "list": [
            {
                "email": "xxxxxxxxxxxx@baidu.com",
                "uuid": ""
            },
            ...
            ...
            ...
        ],
        "page_response": {
            "total": "2897",
            "count": "30",
            "total_page": "97"
        }
    },
    "server_time": "2025-08-08T10:29:18+08:00",
    "version": "v0.0.1"
}
```

```json
{
    "code": 1211003,//code 不为0
    "msg": "Request unknown error",
    "data": null,
    "server_time": "2025-08-08T17:14:10+08:00",
    "version": "v0.0.1"
}
```

--------------------------------

### List DNS History API Request

Source: https://windvane.lichoin.com/docs-api

Endpoint for querying historical DNS records for a specific domain.

```http
POST {{BaseUrl}}/ListDNS
Content-Type: application/json
X-Api-Key: 4b7f68b1-xxxx-xxxx-xxxx-xxx...xxx

{
  "domain": "baidu.com",
  "page_request": {
    "page": 1,
    "count": 30
  }
}
```

--------------------------------

### Query Remaining Frequency Endpoint

Source: https://windvane.lichoin.com/docs-api

Endpoint definition for retrieving the current API usage statistics.

```http
POST: /GetFrequency
```

--------------------------------

### Error API Response

Source: https://windvane.lichoin.com/docs-api

The structure of an API response when an error occurs.

```json
{
    "code": 1211003,//code 不为0
    "msg": "Request unknown error",
    "data": null,
    "server_time": "2025-08-08T17:14:10+08:00",
    "version": "v0.0.1"
}
```
Tokens:
Raw