How to Create an API Auth Key in KS Query

An API authentication key is essential for securely accessing the features and functionalities provided by KS Query. Follow the steps below to create an API auth key.

Prerequisite: Before creating an API Auth Key, you must select a blockchain and network in KS Query. If you haven't done that yet, follow this guide first: How to Select a Blockchain and Network in KS Query

Step 1: Create API Auth Key from the Dashboard

Once you’ve selected a blockchain and network, you'll land directly on the KS Query dashboard. A prompt will appear prompting you to create an API Auth Key to proceed.

Click + Create API Auth Key on the prompt.

Initiate API Key Generation

Note: Alternatively, you can also access this by clicking API Key Generation from the left-hand menu.

Step 2: Fill in Key Details

After clicking the button, a dialog box titled Create API Auth Key will appear.

Create API Auth Key

Fill in the following fields:

• Key Name: A descriptive name (e.g., tradingbot, analytics-script)

• Key Description (optional): Clarify its use (e.g., Key for mainnet data pulls)

Click Create Now to generate the key.

Step 3: View and Copy Your API Key

After creation, you’ll be redirected to the API Key Generation page. Your newly generated API key will be listed here.

View API Key

Tips for Secure API Key Usage

• Keep it safe: Store your key in a secure location like environment variables or secrets managers.

• Do not share: Never expose your API key publicly (e.g., GitHub, frontend code).

• Revoke if compromised: If you suspect unauthorized access, immediately revoke and regenerate a new key.

• Monitor usage: Regularly review your API activity to detect any suspicious requests.

Creating an API auth key in KS Query is a straightforward process that allows secure access to the platform's powerful features. Follow the steps above to set up your key and start utilizing KS Query for your blockchain projects efficiently.