system_api

Module Group: System
Version: 0.1.10

The system_api provides access to general system information about the SDS (Steem Data Services) instance, including active modules, data source states, version information, and availability checks for specific modules and methods.

Endpoints Overview

Endpoint Description Result Type
getDataSources Data source synchronization state JSON Object
getState Complete system state overview JSON Object
getVersion Current SDS version String
hasMethod Check if a specific method exists Boolean
hasModule Check if a specific module is active Boolean

Endpoints

getDataSources

Returns data source state information including synchronization timestamps and block information.

Endpoint

/system_api/getDataSources

Example Request

https://sds.steemworld.org/system_api/getDataSources

Example Response:

{
   "code": 0,
   "result": {
      "accounts": [
         {
            "module_id": "accounts_api",
            "sync_time": 1767703788
         }
      ],
      "blocks": [
         {
            "module_id": "blocks_api",
            "last_irreversible_block": 102369466,
            "last_reversible_block": 0,
            "fields_block": [],
            "fields_transaction": []
         }
      ],
      "posts": [
         {
            "module_id": "posts_api",
            "sync_time": 1767703788
         }
      ],
      "witnesses": [
         {
            "module_id": "witnesses_api",
            "sync_time": 1767703788
         }
      ]
   }
}

Result: JSON Object containing data source categories with their module IDs and sync state

getState

Returns general system state information including all active modules, data sources, and version.

Endpoint

/system_api/getState

Example Request

https://sds.steemworld.org/system_api/getState

Example Response:

{
   "code": 0,
   "result": {
      "active_modules": [
         "account_history_api",
         "accounts_api",
         "authorities_api",
         "blocks_api",
         "chain_api",
         "communities_api",
         "content_history_api",
         "content_search_api",
         "delegations_api",
         "feeds_api",
         "followers_api",
         "mentions_api",
         "notifications_api",
         "post_resteems_api",
         "post_tags_api",
         "posts_api",
         "rewards_api",
         "rrh_api",
         "stats_api",
         "status_api",
         "steem_requests_api",
         "ticker_api",
         "transactions_api",
         "transfers_api",
         "witnesses_api"
      ],
      "data_sources": {
         "accounts": [{"module_id": "accounts_api", "sync_time": 1767703791}],
         "blocks": [{"module_id": "blocks_api", "last_irreversible_block": 102369466, "last_reversible_block": 0}],
         "posts": [{"module_id": "posts_api", "sync_time": 1767703792}],
         "witnesses": [{"module_id": "witnesses_api", "sync_time": 1767703788}]
      },
      "sds_version": "0.1.10"
   }
}

Result Fields:

Field Description
active_modules Array of all currently active API module IDs
data_sources Object containing data source synchronization states
sds_version Current SDS version string

getVersion

Returns the currently running SDS version.

Endpoint

/system_api/getVersion

Example Request

https://sds.steemworld.org/system_api/getVersion

Example Response:

{
   "code": 0,
   "result": "0.1.10"
}

Result: String containing the SDS version number

hasMethod

Checks if a request handler for a specific module and method exists in this SDS instance.

Endpoint

/system_api/hasMethod/:moduleId/:methodId

Parameters

Name Type Optional Description
:moduleId string No The module identifier (e.g., blocks_api)
:methodId string No The method identifier (e.g., getBlock)

Example Request (existing method):

https://sds.steemworld.org/system_api/hasMethod/blocks_api/getBlock

Example Response (method exists):

{
   "code": 0,
   "result": true
}

Example Request (non-existing method):

https://sds.steemworld.org/system_api/hasMethod/blocks_api/nonexistent

Example Response (method does not exist):

{
   "code": 0,
   "result": false
}

Result: Boolean indicating whether the method exists (true) or not (false)

hasModule

Checks if a module with the specified ID is active in this SDS instance.

Endpoint

/system_api/hasModule/:moduleId

Parameters

Name Type Optional Description
:moduleId string No The module identifier to check (e.g., blocks_api)

Example Request (existing module):

https://sds.steemworld.org/system_api/hasModule/blocks_api

Example Response (module exists):

{
   "code": 0,
   "result": true
}

Example Request (non-existing module):

https://sds.steemworld.org/system_api/hasModule/nonexistent_api

Example Response (module does not exist):

{
   "code": 0,
   "result": false
}

Result: Boolean indicating whether the module is active (true) or not (false)

Active Modules List

The following modules are currently active on the SDS instance (as of version 0.1.10):

Module ID Category Description
account_history_api Accounts Account transaction history
accounts_api Accounts Account information and metadata
authorities_api Accounts Account authority/key information
blocks_api Base Block data access
chain_api Base Core blockchain operations
communities_api Posts Steem community data
content_history_api Posts Post/comment edit history
content_search_api Posts Full-text content search
delegations_api Accounts SP delegation tracking
feeds_api Posts User feed generation
followers_api Accounts Follower/following relationships
mentions_api Posts User mention tracking
notifications_api Accounts User notifications
post_resteems_api Posts Resteem/reblog tracking
post_tags_api Posts Tag usage statistics
posts_api Posts Post and comment data
rewards_api Accounts Reward distribution data
rrh_api System Reverse request handler
stats_api System Platform statistics
status_api System System status information
steem_requests_api Base Direct Steem node requests
ticker_api System Market ticker data
transactions_api Base Transaction data access
transfers_api Accounts Transfer history
witnesses_api System Witness information

Data Source Categories

Category Module Description
accounts accounts_api Account data synchronization
blocks blocks_api Block data synchronization
posts posts_api Post/comment data synchronization
witnesses witnesses_api Witness data synchronization

Use Cases

  1. Health checking - Verify the SDS instance is running and synchronized
  2. Feature detection - Check if specific modules/methods are available before calling them
  3. Version compatibility - Ensure your application is compatible with the SDS version
  4. Synchronization monitoring - Track data source sync times and block heights
  5. API discovery - List all available modules on the instance
  6. Debugging - Verify module availability when troubleshooting API calls

Notes

Back to Main Index