unisat-wallet / dev-support

35 stars 18 forks source link

API Endpoint /v3/market/runes/auction/actions Not Returning Expected Data and Documentation Issues #38

Closed theghostmac closed 5 months ago

theghostmac commented 5 months ago

Description

I'm encountering issues with the API endpoint /v3/market/runes/auction/actions. Despite providing the correct authorization and filters, the response always returns an empty list of sales transactions. Additionally, the documentation lacks clarity on several aspects, making it difficult to use the API effectively.

Steps to Reproduce

Here are the exact steps and curl commands I used:

  1. Fetching Sales Transactions without tick Field:
    
    curl -L \
     -X POST \
     -H 'Content-Type: application/json' \
     -H 'Authorization: Bearer AN_API_KEY' \
     'https://open-api.unisat.io/v3/market/runes/auction/actions' \
     -d '{
           "filter": {
             "nftType": "brc20",
             "event": "Sold"
           },
           "start": 0,
           "limit": 50
         }'

Response:

{
  "code": 0,
  "msg": "ok",
  "data": {
    "list": [],
    "total": 0
  }
}

i have tried adding the "tick": "rune", i have tried using CAT IN THE SATS's "inscriptionId": "842403:1231". none worked.

Issues Encountered

Empty Data Response: Despite using valid filter parameters, the response always returns an empty list. It's unclear if additional parameters are needed or if the data is not available.

Documentation Gaps:

Filter Parameters: The documentation does not specify what values should be used for fields such as address and inscriptionId. Endpoints for Inscription IDs: There is no clear endpoint for retrieving inscription IDs, which are necessary for filtering sales transactions. Example Requests: The lack of detailed examples makes it difficult to understand how to properly form requests. Suggested Improvements Detailed Documentation: Provide comprehensive documentation with detailed descriptions of all available filter parameters, including valid values and examples. Example Use Cases: Add detailed example requests and responses for common use cases to help users understand how to use the API effectively.

Thank you.

xhyhh0 commented 5 months ago
curl -L \
  -X POST \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AN_API_KEY' \
  'https://open-api.unisat.io/v3/market/brc20/auction/actions' \
  -d '{
        "filter": {
          "nftType": "brc20",
          "event": "Sold"
        },
        "start": 0,
        "limit": 50
      }'

v3/market/runes should be v3/market/brc20

The document indeed needs improvement, thank you for your suggestion.