From 84c301601263a3a37641651ed18f66781cb14e76 Mon Sep 17 00:00:00 2001 From: Nandha22 Date: Tue, 31 Dec 2024 20:57:59 +0530 Subject: [PATCH] Error response added --- api/cat/holders.md | 9 +++++++++ api/cat/info.md | 10 ++++++++++ api/cat/list.md | 4 ++-- api/cat/price.md | 10 ++++++++++ api/cat/update.md | 17 +++++++++++++---- 5 files changed, 44 insertions(+), 6 deletions(-) diff --git a/api/cat/holders.md b/api/cat/holders.md index 254d8dc1..56989b50 100644 --- 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 index 01587117..be9a8fd2 100644 --- 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 | \ No newline at end of file diff --git a/api/cat/list.md b/api/cat/list.md index f8427c71..89d08c60 100644 --- 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¤cy=USD" - + - + diff --git a/api/cat/price.md b/api/cat/price.md index 04d57dd1..2815ddaf 100644 --- 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 | \ No newline at end of file diff --git a/api/cat/update.md b/api/cat/update.md index 165053fa..d1970cd3 100644 --- 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 | -| ----- | ------ | -------------------- | ----------------------------- | --- | -| | -| 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