Skip to content

Latest commit

 

History

History
152 lines (130 loc) · 4.7 KB

quickstart.mdx

File metadata and controls

152 lines (130 loc) · 4.7 KB
title description
Getting Started
Start using POND3R in under 5 minutes

Getting Started with POND3R

This guide will help you quickly get started with POND3R's web app and API to access Web3 data through natural language.

Using the Web3 Data Chat

The Web3 Data Chat is the easiest way to start exploring blockchain data without any technical setup.

Go directly to [makeit.pond3r.xyz](https://makeit.pond3r.xyz). Type a natural language question in the chat box, such as: ``` What are the top 5 Uniswap pools on Base by volume in the last 24 hours? ``` or ``` What's the current price of ETH? ``` POND3R will process your question, find the relevant data sources, and return a human-readable answer with visualizations when applicable. You can ask follow-up questions to drill down into the data. For example: ``` How has the volume changed compared to last week? ``` POND3R maintains context from previous questions to provide more relevant answers.

Connecting to the API

For developers looking to integrate POND3R's capabilities into their applications:

Use the following code example to make a basic request to the POND3R API: 
<CodeGroup>
  <CodeBlock title="Node.js" language="javascript">
  ```javascript
  const axios = require('axios');

  async function queryPond3r() {
    try {
      const response = await axios.post('https://api.pond3r.xyz/v1/messages', {
        prompt: 'Get the current price of ETH'
      }, {
        headers: {
          'x-api-key': 'YOUR_API_KEY',
          'Content-Type': 'application/json'
        }
      });
      
      console.log(response.data);
    } catch (error) {
      console.error('Error querying POND3R:', error.response ? error.response.data : error.message);
    }
  }

  queryPond3r();
  ```
  </CodeBlock>
  <CodeBlock title="Python" language="python">
  ```python
  import requests

  def query_pond3r():
      url = 'https://api.pond3r.xyz/v1/messages'
      headers = {
          'x-api-key': 'YOUR_API_KEY',
          'Content-Type': 'application/json'
      }
      data = {
          'prompt': 'Get the current price of ETH'
      }
      
      try:
          response = requests.post(url, json=data, headers=headers)
          response.raise_for_status()
          print(response.json())
      except requests.exceptions.RequestException as e:
          print(f"Error querying POND3R: {e}")
          
  if __name__ == "__main__":
      query_pond3r()
  ```
  </CodeBlock>
</CodeGroup>
The API returns JSON responses in this format: 
```json
{
  "result": "The current price of ETH is $2088.21 as of March 24, 2024.",
  "threadId": "33d2a1d4-577a-4ce8-bca7-7af564761ed8",
  "status": "success"
}
```

- `result`: Contains the natural language response to your query
- `threadId`: A unique identifier for continuing the conversation
- `status`: Indicates whether the request was successful
To ask follow-up questions that maintain context, include the `threadId` in subsequent requests: 
<CodeGroup>
  <CodeBlock title="Node.js" language="javascript">
  ```javascript
  // Follow-up question with threadId
  const followUpResponse = await axios.post('https://api.pond3r.xyz/v1/messages', {
    prompt: 'How has it changed in the last week?',
    threadId: '33d2a1d4-577a-4ce8-bca7-7af564761ed8'  // Use the threadId from the previous response
  }, {
    headers: {
      'x-api-key': 'YOUR_API_KEY',
      'Content-Type': 'application/json'
    }
  });
  ```
  </CodeBlock>
</CodeGroup>

Next steps

Now that you've made your first queries with POND3R, you can:

See examples of effective queries for different types of blockchain data Learn what chains, protocols, and data types POND3R can access Get detailed information about API endpoints and parameters