Merge pull request #169 from spacescan-io/Dev-nandha

Error response added
spacescan-io · Dec 31, 2024 · e79c714 · e79c714
2 parents de8f2fd + 84c3016
commit e79c714
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 6 deletions.
diff --git a/api/cat/holders.md b/api/cat/holders.md
@@ -158,3 +158,12 @@ Each holder in the `tokens` array contains:
 |------------------|---------|-------------------------------------------------------|
 | address          | string  | The holder's address                                  |
 | amount           | string  | The amount of CAT tokens held                         |
+
+### Error Responses
+
+| HTTP Status Code | Meaning |
+|-----------------|---------|
+| 400 | Bad Request -- Invalid parameters |
+| 429 | Too Many Requests -- Rate limit exceeded |
+| 500 | Internal Server Error |
+| 503 | Service Unavailable | 
diff --git a/api/cat/info.md b/api/cat/info.md
@@ -162,3 +162,13 @@ fetch(url)
 | burned | number | Number of tokens burned |
 | melted | number | Number of tokens melted |
 | circulating_supply | number | Current circulating supply |
+
+
+### Error Responses
+
+| HTTP Status Code | Meaning |
+|-----------------|---------|
+| 400 | Bad Request -- Invalid parameters |
+| 429 | Too Many Requests -- Rate limit exceeded |
+| 500 | Internal Server Error |
+| 503 | Service Unavailable | 
diff --git a/api/cat/list.md b/api/cat/list.md
@@ -137,10 +137,10 @@ curl -X GET "https://pro-api.spacescan.io/cats?include_price=true&currency=USD"
 
 <Tabs>
   <TabItem value="mainnet" label="Mainnet">
-    <ApiCallExample endpoint="https://api.spacescan.io/cats" />
+    <ApiCallExample endpoint="https://api.spacescan.io/cats?count=10" />
   </TabItem>
   <TabItem value="testnet" label="Testnet">
-    <ApiCallExample endpoint="https://api-testnet11.spacescan.io/cats" />
+    <ApiCallExample endpoint="https://api-testnet11.spacescan.io/cats?count=10" />
   </TabItem>
 </Tabs>
 

diff --git a/api/cat/price.md b/api/cat/price.md
@@ -158,3 +158,13 @@ curl -X GET "https://pro-api.spacescan.io/token/price/{asset_id}?currency=USD" \
 |-------|------|-------------|
 | [currency] | string | Price in specified currency (e.g., "usd": 0.02624364935709997) |
 | xch | string | Price in XCH |
+
+
+### Error Responses
+
+| HTTP Status Code | Meaning |
+|-----------------|---------|
+| 400 | Bad Request -- Invalid parameters |
+| 429 | Too Many Requests -- Rate limit exceeded |
+| 500 | Internal Server Error |
+| 503 | Service Unavailable | 
diff --git a/api/cat/update.md b/api/cat/update.md
@@ -164,10 +164,10 @@ curl -X POST "https://pro-api.spacescan.io/cat/info/updatecat" \
 
 ### Response Schema
 
-| Field | Type   | Description          |
-| ----- | ------ | -------------------- | ----------------------------- | --- |
-| <!--  | status | string               | The status of the API request | --> |
-| data  | object | Response data object |
+| Field   | Type    | Description                                      |
+| ------- | ------- | ------------------------------------------------ |
+| status  | string  | The status of the API request                    |
+| data    | object  | Response data object                             |
 
 #### Data Object
 
@@ -187,6 +187,15 @@ curl -X POST "https://pro-api.spacescan.io/cat/info/updatecat" \
 }
 ```
 
+### Error Responses
+
+| HTTP Status Code | Meaning |
+|-----------------|---------|
+| 400 | Bad Request -- Invalid parameters |
+| 429 | Too Many Requests -- Rate limit exceeded |
+| 500 | Internal Server Error |
+| 503 | Service Unavailable | 
+
 ### Important Notes
 
 - The signature must be generated using the Chia wallet