Utility
// TODO: Add description
Method Declaration
Get Time
Get current server time of the Indexer.
Method Declaration
Python
async def get_time(self) -> Dict[str, str]Parameters
| Parameter | Location | Type | Required | Description |
|---|
Response
| Status | Meaning | Schema |
|---|---|---|
200 | OK | TimeResponse |
Get Height
Current block height and block time (UTC) parsed by the Indexer.
Method Declaration
Python
async def get_height(self) -> Dict[str, str]Parameters
| Parameter | Location | Type | Required | Description |
|---|
Response
| Status | Meaning | Schema | Description |
|---|---|---|---|
200 | OK | HeightResponse ⛁ | Dictionary containing the block height and time. |
Get Screen
Query for screening results (compliance) of the address.
Method Declaration
Python
async def screen(self, address: str) -> Dict[str, bool]:Parameters
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
address | query | Address | true | The wallet address that owns the account. |
Response
| Status | Meaning | Schema | Description |
|---|---|---|---|
200 | OK | ComplianceResponse ⛁ | The compliance data. |
400 | Bad Request | The request was malformed or invalid. |
API Example
Get Compliance Screen
Screen an address to see if it is restricted.
Method Declaration
Python
async def compliance_screen(self, address: str) -> AnyParameters
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
| address | Path | string | true | evm or ritbit address |
Response
| Status | Meaning | Schema | Description |
|---|---|---|---|
200 | OK | ComplianceV2Response | whether the specified address is restricted |
400 | Bad Request | The request was malformed or invalid. |
API Example