Address book list - Uptick Service Documentation

Request

Query Params

pageNumber

integer <int32>

optional

Pagination page numbers, with a default value of 1.

pageSize

integer <int32>

optional

The number of records per page is 10 by default, with an upper limit of 50.

searchKey

string

optional

Search key

address

string

optional

address

Header Params

Content-Type

required

Constant value：application/json

X-Api-Key

required

Project API Key, used for API access authorization.

X-Signature

required

API Signature, with the algorithm being SHA256(Params + Timestamp + ApiSecret).

X-Timestamp

required

Timestamp, the number of milliseconds from 00:00:00 on January 1st, 1970 to the present.

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.services.uptick.network/api/v1/addressBook/list' \
--header 'X-Api-Key;' \
--header 'X-Signature;' \
--header 'X-Timestamp;'

Responses

🟢200OK

application/json

OK

Body

code

integer <int32>

optional

Status code

data

object (PageQuery«AddressBook»)

optional

Return result.

firstPage

boolean

optional

lastPage

boolean

optional

list

array[object (AddressBook) {10}]

optional

orderBy

string

optional

pageNumber

integer <int64>

optional

pageSize

integer <int64>

optional

paras

object

optional

totalPage

integer <int64>

optional

totalRow

integer <int64>

optional

msg

string

optional

Error messages will be returned.

success

boolean

optional

The request was successful.

Example:

false

Example

{
    "code": 0,
    "data": {
        "firstPage": true,
        "lastPage": true,
        "list": [
            {
                "address": "string",
                "chainId": "string",
                "contactAddress": "string",
                "createTime": "2019-08-24T14:15:22Z",
                "createTimeLong": 0,
                "deleted": true,
                "id": 0,
                "projectId": 0,
                "remark": "string",
                "updateTime": "2019-08-24T14:15:22Z"
            }
        ],
        "orderBy": "string",
        "pageNumber": 0,
        "pageSize": 0,
        "paras": {},
        "totalPage": 0,
        "totalRow": 0
    },
    "msg": "string",
    "success": false
}

🟠401Unauthorized

🟠403Forbidden

🔴500Server Error