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
Parameter Name | Type | Required | Description |
---|---|---|---|
elven-api-key | String | Yes | The API key assigned to you |
elven-api-sign | String | Yes | Request signature, used to verify the legitimacy of the request |
elven-api-timestamp | String | Yes | Request timestamp, in milliseconds |
Request Parameters
Query Parameters
Parameter Name | Type | Required | Description |
---|---|---|---|
page | Number | No | The page number to retrieve. Defaults to 1 if not provided. |
limit | Number | No | The number of records per page. Defaults to 10 if not provided. |
keyword | String | No | A keyword for fuzzy search. If omitted, no filtering is applied. |
Example Request
Response Parameters
Parameter Name | Type | Description |
---|---|---|
total | Number | Total number of platforms matching the query. |
list | Array | A list of platforms |
list of objects
Parameter Name | Type | Description |
---|---|---|
platformId | String | The primary key of the platform. |
name | String | The name of the platform. |
type | String | The type of the platform Value: |
Example Response
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.
Last updated