Skip to content

How to View All APIs in KS Query

Tip

To proceed with the flow, one must first select the Blockchain and network, then create or select an active API authentication key, and finally retrieve all APIs.

Info

Users can currently select only the KALP DLT chain and the Test Net network. Support for other options, such as Ethereum and Binance, will be introduced in upcoming releases.

The KS Query platform allows users to easily access and explore various APIs. Here’s a step-by-step guide to viewing all available APIs in KS Query:

Step 1: Navigate to the Dashboard

  1. Visit the Kalp Studio website.

  2. Log in to your account using your credentials. If you don’t have an account, sign up to create one.

  3. Once logged in, you’ll be redirected to the Dashboard, where you can explore various products and features.

  4. From the Dashboard, scroll down to the Our Products section.

enter image description here

5.Find KS Query and click Explore under KS Query in the Our Products section to proceed.

  • Navigate to the Dashboard section.
  • The Dashboard provides a summary of your API usage and subscription details.

enter image description here

Step 2: Go to the "All APIs" Section

  • Click on the "All APIs" option in the left-hand menu.
  • This will take you to a detailed view showcasing all the APIs available under your subscription.

Step 3: Viewing APIs in KS Query: Organized by Categories

The KS Query platform allows users to explore APIs categorized into Channels, Smart Contracts, Blocks, Transactions, and Network List. Here's how you can view and interact with APIs based on these categories:

1. Channels

The Channel section provides APIs related to channel data, allowing you to fetch channel-related information.

enter image description here

  • How to Access:

    • Navigate to the "All APIs" tab on the left-hand menu.
    • Select the Channel tab on the top of the API list.

    • Features Available:

    • Retrieve Channel Information: Use APIs to fetch details such as channel IDs, names, and related metadata.

    • Example API Actions:
      • GET APIs for fetching lists of channels.
      • Parameters can be checked by clicking the "Check Params" button.

2. Smart Contracts

The Smart Contracts category includes APIs for interacting with and retrieving data about smart contracts.

enter image description here

  • How to Access:

    • Under the "All APIs" section, click on the Smart Contracts tab.

    • Features Available:

    • Get Smart Contract Details: Retrieve information like deployed smart contracts, associated data, and usage statistics.

    • Example API Actions:
      • GET APIs to fetch a list of deployed contracts or specific contract details.
      • Use "Check Params" for parameter insights.

3. Blocks

enter image description here

The Blocks section provides APIs for interacting with blockchain blocks.

  • How to Access:

    • From the "All APIs" page, select the Blocks tab.

    • Features Available:

    • Retrieve Block Data: Fetch details about blocks on the blockchain, such as block height, hash, or transaction counts.

    • Example API Actions:
      • GET APIs for listing blocks or fetching block-specific information.
      • Use the "Check Params" button to view required inputs.

4. Transactions

enter image description here

The Transaction category provides APIs for accessing transaction-level details on the blockchain.

  • How to Access:

    • Navigate to the Transaction tab under the "All APIs" section.

    • Features Available:

    • Fetch Transaction Details: View transaction data, including transaction IDs, statuses, and associated events.

    • Example API Actions:
      • GET APIs to retrieve transaction lists or specific transaction details by ID.
      • "Check Params" helps you understand required query parameters.

5. Network List

enter image description here

The Network List provides a comprehensive list of supported networks and blockchains accessible through KS Query.

  • How to Access:

    • Under the "All APIs" section, select the Network List tab.

    • Features Available:

    • View Supported Networks: See details of blockchains like KALP DLT, Ethereum (Mainnet and Testnet), Binance Smart Chain, and more (upcoming).

    • Network Details: The list displays blockchain name and the corresponding network (e.g., Devnet, Mainnet, Testnet).

Conclusion

By categorizing APIs into Channels, Smart Contracts, Blocks, Transactions, and Network List, KS Query ensures a seamless user experience.

Note

If you encounter any issues related to Kalp Studio, please raise a support ticket at care.kalp.studio. Our dedicated development team will assist you in finding the best possible solution.