Skip to main content

API Usage Scores

Usage scores for each API endpoint are listed in detail below. Each request consumes a specific score, and you have a total available score based on your agreement.

Scoring System​

Score Calculation​

  • Each API request consumes a specific score
  • Scores vary by endpoint
  • Your total score depends on your agreement

Endpoint Scores​

Authentication Endpoints​

EndpointMethodScoreDescription
/v2/auth/clientsPOST1000Create client
/v2/auth/tokensPOST1000Create token

Category Endpoints​

EndpointMethodScoreDescription
/v2/admin/categories/{category_id}GET0Get category information
/v2/admin/categories/rootGET0Get root categories
/v2/admin/categories/{category_id}/childrenGET1000Get child categories

Fee Endpoints​

EndpointMethodScoreDescription
/v2/fees/nodes/{node_id}POST1000Create node fee
/v2/fees/nodes/{node_id}/platformPOST1000Create node platform fee
/v2/fees/platformPOST1000Create platform fee
/v2/fees/nodes/{node_id}GET1000Get node fee
/v2/fees/nodes/{node_id}/platformGET1000Get node platform fee
/v2/fees/platformGET1000Get platform fee
/v2/fees/nodes/{node_id}PUT1000Update node fee
/v2/fees/nodes/{node_id}/platformPUT1000Update node platform fee
/v2/fees/platformPUT1000Update platform fee

Node Endpoints​

EndpointMethodScoreDescription
/v2/admin/nodePOST1000Create node
/v2/admin/node/{node_id}DELETE1000Delete node
/v2/admin/node/{node_id}/deploy-contractPOST1000Deploy contract
/v2/admin/node/{node_id}/childrenGET1000Get child nodes
/v2/admin/node/{node_id}/contract-statusGET1000Get contract status
/v2/admin/node/{node_id}GET0Get node information
/v2/admin/node/rootGET1000Get root nodes
/v2/admin/node/{node_id}/wallet-summaryGET1000Get wallet summary
/v2/admin/node/{node_id}PUT1000Update node

Supervisor Endpoints​

EndpointMethodScoreDescription
/v2/admin/supervisor/nodes/{node_id}GET1000Get node supervisor

Token Endpoints (Admin)​

EndpointMethodScoreDescription
/v2/admin/token/{token_id}/burnPOST1000Burn token
/v2/tokensPOST1000Create token
/v2/admin/token/{token_id}DELETE1000Delete token
/v2/admin/token/{token_id}/delistPOST1000Delist token
/v2/admin/token/{token_id}/transactionsGET1000Get token transactions
/v2/admin/token/{token_id}GET0Get token information
/v2/tokensGET1000Get tokens
/v2/admin/token/{token_id}/listPOST1000List token
/v2/admin/token/{token_id}/otcPOST1000Open token to OTC
/v2/admin/token/{token_id}/secondary-marketPOST1000Open token to secondary market
/v2/admin/token/{token_id}/passivePOST1000Make token passive
/v2/admin/token/{token_id}/public-transferPOST1000Make token public transfer
/v2/admin/token/{token_id}/rentPOST1000Make token rentable
/v2/admin/token/{token_id}/metricsPUT1000Update token metrics
/v2/admin/token/{token_id}PUT1000Update token

User Endpoints​

EndpointMethodScoreDescription
/v2/users/{user_id}GET0Get user information
/v2/users/{user_id}PUT1000Update user
/v2/users/{user_id}/walletPUT1000Update user wallet

Purchases Endpoints​

EndpointMethodScoreDescription
/v2/users/purchases/users/{user_id}/group-searchPOST2000Search purchase groups
/v2/users/purchases/users/{user_id}/searchPOST1000Search purchase transactions
/v2/users/purchases/users/{user_id}/tokens/{token_id}/quantityGET1000Get token quantity
/v2/users/purchases/users/{user_id}/tokens/{token_id}/buy-on-primary-marketPOST1000Buy on primary market
/v2/users/purchases/users/{user_id}/tokens/{token_id}/buy-on-secondary-marketPOST1000Buy on secondary market

Secondary Markets Endpoints​

EndpointMethodScoreDescription
/v2/users/secondary-markets/users/{user_id}/group-searchPOST2000Search secondary market groups
/v2/users/secondary-markets/users/{user_id}/tokens/{token_id}POST1000Get secondary market deals
/v2/users/secondary-markets/users/{user_id}/tokens/{token_id}/sellPOST1000Sell on secondary market
/v2/users/secondary-markets/users/{user_id}/tokens/{token_id}/delistPOST1000Delist from secondary market

OTCs Endpoints​

EndpointMethodScoreDescription
/v2/users/otcs/users/{user_id}/group-searchPOST2000Search OTC groups
/v2/users/otcs/users/{user_id}/tokens/{token_id}POST1000Get OTC deals
/v2/users/otcs/users/{user_id}/tokens/{token_id}/sellPOST1000Sell on OTC
/v2/users/otcs/users/{user_id}/tokens/{token_id}/cancelPOST1000Cancel OTC deal

Token Endpoints (User Operations)​

EndpointMethodScoreDescription
/v2/admin/token/users/searchPOST1000Search tokens
/v2/admin/token/users/{token_id}GET0Get token information
/v2/admin/token/users/{token_id}/users/{user_id}/burnPOST1000Burn user token

Admin OTCs Endpoints​

EndpointMethodScoreDescription
/v2/admin/otcs/nodes/{node_id}/group-searchPOST2000Search admin OTC groups
/v2/admin/otcs/nodes/{node_id}/tokens/{token_id}POST1000Get admin OTC deals
/v2/admin/otcs/nodes/{node_id}/tokens/{token_id}/deals/{deal_id}/acceptPOST1000Accept admin OTC deal
/v2/admin/otcs/nodes/{node_id}/tokens/{token_id}/deals/{deal_id}/cancelPOST1000Cancel admin OTC deal

Score Categories​

0 Score - Free Endpoints​

  • Basic information retrieval operations
  • Frequently used, lightweight operations
  • Total: 4 endpoints

1000 Score - Standard Endpoints​

  • Normal CRUD operations
  • Endpoints operating on single records
  • Simple data processing operations
  • Total: 40+ endpoints

2000 Score - Group Search Endpoints​

  • Complex search and filtering operations
  • Operations on large datasets
  • Operations requiring multiple database queries
  • Total: 4 endpoints

Score Management​

Total Score​

  • You have a monthly total score based on your agreement
  • This score is shared across all endpoints
  • API access is restricted when score is exhausted

Score Tracking​

  • Your remaining score is updated after each request
  • Your score status is indicated in API responses
  • Your monthly score is renewed

Example Calculation​

Your Monthly Score: 100,000

Daily Usage:

  • 5 Group Search requests: 5 × 2000 = 10,000 score
  • 20 Standard endpoint requests: 20 × 1000 = 20,000 score
  • 10 Free endpoint requests: 10 × 0 = 0 score
  • Total Daily: 30,000 score
  • Remaining Score: 70,000 score

Score Optimization​

Efficient Usage​

  • Don't use Group Search endpoints unnecessarily
  • Prefer free endpoints
  • Perform data filtering operations on the client side when possible

Recommendations​

  • Use pagination for large datasets
  • Store frequently used data locally
  • Prevent unnecessary requests

Error Conditions​

When Score is Exhausted​

  • API requests return 429 Too Many Requests error
  • You must wait until the new monthly period begins
  • Score package upgrade options are available

Score Control​

  • Check your remaining score before each request
  • Ensure you have sufficient score for critical operations
  • Regularly monitor your score usage