Beosin API Documentation
  • ⭐Getting Started
    • Get API Access key
    • Verification
    • Setting the risk strategy
    • Setting the risk score
  • 🎯API Endpoints
    • Basic
      • Account balance query
    • Compliance
      • Deposit Transaction Assessment
        • Change Logs
      • Withdrawal Transaction Assessment
        • Change Logs
      • EOA Address Risk Assessment
        • Change Logs
      • EOA Address Risk Assessment (Deprecated)
        • Change Logs
      • Token Risk Assessment (Deprecated)
      • Malicious Address Query
        • Change Logs
      • VASP Query
        • Change Logs
      • Entity Query (Deprecated)
        • Change Logs
    • Security
      • 1. Black address screening
  • 🤝Support
    • Common Result Messages
    • Rate Limits
    • Some Common Labels and Types
    • Supported Blockchain Platforms
    • Common Sanction Guidelines and Sanctioned Entities
    • Contact Us
Powered by GitBook
On this page
  • Applicable Scenarios
  • Description
  • Basic Info
  • Header Request Parameter
  • Return Parameter
  • Example of Request Data
  • Example of Response Data
  1. API Endpoints
  2. Basic

Account balance query

Applicable Scenarios

You can keep track of the current balance of your API account credits at any time. By monitoring your credit balance, you can ensure uninterrupted access to API services and avoid potential disruptions caused by insufficient credits.

Description

The API Account Credit Query endpoint retrieves the current credit balance for an organization or individual account. This query is informational only and does not deduct any credits from your account.

Basic Info

  • Request method: GET

  • Interface URL: https://api.beosin.com/api/v1/package/info

  • Content-Type: application/json

  • Verification method: SIGN

  • Response Time:<8s

Header Request Parameter

Parameter
Required Field (Y/N)
Parameter Type
Description

Y

String

Unique authentication APPID assigned by KYT system

Y

String

Unique authentication APP-SECRET assigned by KYT system

Return Parameter

Parameter
Parameter Type
Description

code

Number

Status code

msg

String

Result Message

data

Object

Result set

data.surplusIntegral

Integer

Remaining credits

data.equityStartDate

Long

Equity start time

data.equityEndDate

Long

Equity end time

Example of Request Data

https://api.beosin.com/api/v1/package/info

Example of Response Data

{
    "code": 200,
    "msg": "success",
    "data": {
        "surplusIntegral": 4838680,
        "equityStartDate": 1704038400,
        "equityEndDate": 1772208000
    }
}
PreviousBasicNextCompliance

Last updated 4 months ago

🎯
APPID
APP-SECRET