oceanprotocol/docs
1
0
Fork 0
mirror of https://github.com/oceanprotocol/docs.git synced 2024-11-26 19:49:26 +01:00
Code Releases Activity

GITBOOK-255: change request with no subject merged in GitBook

Browse Source
This commit is contained in:
Jamie Hewitt 2023-05-23 18:54:09 +00:00 committed by gitbook-bot
parent 5b9a4d0bd8
commit c126607b56
No known key found for this signature in database
GPG Key ID: 07D2180C7B12D0FF
1 changed files with 29 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
developers/aquarius/chain-requests.md
View File

@ -4,11 +4,24 @@ The universal Aquarius Endpoint is [`https://v4.aquarius.oceanprotocol.com`](htt
### Chain List
GET `/api/aquarius/chains/list`
Retrieves a list of chains that are currently supported or recognized by the Aquarius service.
#### Description
* **Endpoint**: `GET /api/aquarius/chains/list`
* **Purpose**: This endpoint provides a list of the chain IDs that are recognized by the Aquarius service. Each chain ID represents a different blockchain network, and the boolean value indicates if the chain is currently active (true) or not (false).
* **Parameters**: This endpoint does not require any parameters. You simply send a GET request to it.
Get chains list
Here are some typical responses you might receive from the API:
* **200**: This is a successful HTTP response code. It means the server has successfully processed the request and returns a JSON object containing chain IDs as keys and their active status as values. 
Example response:
```
{ "246": true, "3": true, "137": true,
"2021000": true, "4": true, "1": true,
"56": true, "80001": true, "1287": true
}
```
#### Curl Example
@ -27,28 +40,23 @@ console.log(response.data)
```
#### Response
`200`
Description: Successful request
Body:
```
{ "246": true, "3": true, "137": true,
"2021000": true, "4": true, "1": true,
"56": true, "80001": true, "1287": true
}
```
### **Chain Status**
GET `/api/aquarius/chains/status/{chain_id}`
Retrieves the index status for a specific chain\_id from the Aquarius service.
#### Description
* **Endpoint**: `GET /api/aquarius/chains/status/{chain_id}`
* **Purpose**: This endpoint is used to fetch the index status for a specific blockchain chain, identified by its chain\_id. The status, expressed as the "last\_block", gives the most recent block that Aquarius has processed on this chain.
* **Parameters**: This endpoint requires a chain\_id as a parameter in the path. This chain\_id represents the specific chain you want to get the index status for.
Get index status for a specific chain\_id
Here are some typical responses you might receive from the API:
* **200**: This is a successful HTTP response code. It means the server has successfully processed the request and returns a JSON object containing the "last\_block", which is the most recent block that Aquarius has processed on this chain. In the response example you provided, "25198729" is the last block processed on the chain with the chain\_id "137".
Example response:
```
{"last_block": 25198729}
```
#### Curl Example
@ -68,14 +76,3 @@ console.log(response.data)
```
#### Response
`200`
Description: Successful request
Body:
```
{"last_block": 25198729}
```