Elven Docs
English
English
  • Getting Started
  • System Configuration
    • Getting started with Elven
    • Project and Entities
      • Choose an Accounting Start Date
    • Inviting team members
    • Viewing activity logs
  • Financial Configuration
    • Configure Chart of Accounts
    • Configure Journal types
    • Configure Auxiliary Accounting
    • Setting Account Opening Balance
  • ACOUNT MANAGEMENT
    • Importing account balances
    • Importing transactions
      • Importing derivatives transactions
    • Verifying account balances
    • Counterparty Accounts Management
      • Managing counterparties
      • Automated counterparty identification
  • Transactions management
    • Transactions overview
  • Bookkeeping
    • Accounting with transaction data
      • Tagging of transactions
      • Rule based tagging
    • Accounting with business data
      • Importing business data using API
      • Importing business data with CSV file
      • Automated bookkeeping of business data
  • ASSETS AND VALUATIONS
    • Assets management
      • Add tokens via smart contract
      • Customising price feeds for assets
    • Fair value of Crypto assets and adjustments
    • Currency exchange (FX) PnL adjustment
    • Derivatives unrealized PnL adjustment
    • Broker business inventory management
  • RECONCILIATION
    • Transaction Reconciliation
  • REPORTS
    • Trial balance
    • Account Balance sheet
    • Financial statements
    • Crypto assets disclosure form
    • Dashboard
  • OpenAPI
    • Obtaining API Authorization
    • Import Business Data
    • Create Account
    • Query Account
    • Create Source
    • Query Source
    • Import Transfer
    • Import Trade
    • Import Gain/Loss
    • Import Account Balances
    • Import Price
    • Query Platform
    • Query Currency
    • Timezone
Powered by GitBook
On this page
  • API Overview
  • Request Headers
  • Request Parameters
  • Response Parameters
  • Notes

Was this helpful?

  1. OpenAPI

Query Platform

PreviousImport PriceNextQuery Currency

Last updated 6 months ago

Was this helpful?

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

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

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:CHAIN、BANK、EXCHANGE、CUSTODY、PAYMENT

Example Response

{
    "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.

View Details