# Query Platform

### API Overview

This API is used to query the list of platforms in the system, supporting pagination and keyword-based fuzzy search.

* **Request Method：**`GET`
* **Request URL：**`https://openapi.elven.com/open/v3/platform`

### Request Headers

<table><thead><tr><th width="202">Parameter Name</th><th width="90">Type</th><th width="100">Required</th><th>Description</th></tr></thead><tbody><tr><td>elven-api-key</td><td>String</td><td>Yes</td><td>The API key assigned to you</td></tr><tr><td>elven-api-sign</td><td>String</td><td>Yes</td><td>Request signature, used to verify the legitimacy of the request</td></tr><tr><td>elven-api-timestamp</td><td>String</td><td>Yes</td><td>Request timestamp, in milliseconds</td></tr></tbody></table>

[View Details](https://docs.elven.com/v3/~/changes/YkdBoYHdjwadymwIANKf/openapi/obtaining-api-authorization?r=LJbAoiJKFX1i7Py2GCYr)

### Request Parameters

#### Query Parameters

<table><thead><tr><th width="202">Parameter Name</th><th width="94">Type</th><th width="99">Required</th><th>Description</th></tr></thead><tbody><tr><td>page</td><td>Number</td><td>No</td><td>The page number to retrieve. Defaults to 1 if not provided.</td></tr><tr><td>limit</td><td>Number</td><td>No</td><td>The number of records per page. Defaults to 10 if not provided.</td></tr><tr><td>keyword</td><td>String</td><td>No</td><td>A keyword for fuzzy search. If omitted, no filtering is applied.</td></tr></tbody></table>

#### Example Request

```bash
GET https://openapi.elven.com/open/v3/platform?page=1&limit=10
```

### Response Parameters

<table><thead><tr><th width="178">Parameter Name</th><th width="96">Type</th><th>Description</th></tr></thead><tbody><tr><td>total</td><td>Number</td><td>Total number of platforms matching the query.</td></tr><tr><td>list</td><td>Array</td><td>A list of platforms</td></tr></tbody></table>

#### list of objects&#x20;

<table><thead><tr><th width="181">Parameter Name</th><th width="100">Type</th><th>Description</th></tr></thead><tbody><tr><td>platformId</td><td>String</td><td>The primary key of the platform.</td></tr><tr><td>name</td><td>String</td><td>The name of the platform.</td></tr><tr><td>type</td><td>String</td><td><p>The type of the platform</p><p>Value：<code>CHAIN</code>、<code>BANK</code>、<code>EXCHANGE</code>、<code>CUSTODY</code>、<code>PAYMENT</code></p></td></tr></tbody></table>

#### Example Response

```json
{
    "total": 2,
    "list": [
        {
            "platformId": "platformId123",
            "name": "Bitcoin Network",
            "type": "CHAIN"
        },
        {
            "platformId": "platformId456",
            "name": "Bank of America",
            "type": "BANK"
        }
    ]
}
```

### **Notes**

* The following headers are required for all requests to ensure security and validity: elven-api-key,elven-api-sign,elven-api-timestamp
* If page and limit are not provided, the API defaults to returning the first page with 10 records per page. If keyword is not provided, no keyword filtering is applied.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.elven.com/v3/openapi/query-platform.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.