⚙️API

Get Real-time Data

1. Get Data

2. Get User Status

Endpoint

Endpoint /client/data/status

Query

Query
Item Name
Description

apiKey

api key

required

Return (Output)

  1. Current Month Active User

  2. Current month registered user

  3. Revoke users of the current month

  4. All

  5. Active Intended to cancel subscription (User has unsubscribed)

  6. Unsubscribed

Example Response

{ "data": { "currentMonthActiveUsers": 501, "currentMonthRegisteredUsers": 0, "currentMonthInactiveUsers": 0, "allUser": 503, "activeUsers": 501, "intendCancelUsers": 0, "unsubscribedUsers": 2 }, "message": "Success", "statusCode": 200 }

3. Get User List

Endpoint

Endpoint /client/data/members

Query

Query
Item Name
Description

page

return page

default: 1 min: 1

limit

limit items to single page

default: 1 min: 1 max: 1

apiKey

api key

required

Return (Output)

  1. Registration date

  2. Situation

  3. Email address

  4. 0x address

  5. Last successful payment

  6. Payment count

Example Response

{ "data": { "items": [ { "address": "0x57ef6f871888e2d294470a0061292675f6dc309c", "email": "[email protected]", "agreementStatus": false, "agreementDate": "2023-06-08T04:53:37.812Z", "chargeTime": 2, "lastChargeSuccess": "2023-06-06T08:15:34.290Z" }, { "address": "0x8dad6c0483657a12111f8266ca1f9e8a93aeb3fe", "email": "[email protected]", "agreementStatus": false, "agreementDate": "2023-06-08T01:49:32.656Z", "chargeTime": 0, "lastChargeSuccess": null } ], "totalItems": 100, "page": 1, "limit": 2, "totalPages": 50 }, "message": "Success", "statusCode": 200 }

4. Get User Detail

Endpoint

Endpoint /client/data/members/{userAddress}

Parameter (Input)

Parameter
Item Name
Description

userAddress

userAddress

required

Query

Query
Item Name
Description

apiKey

api key

required

Return (Output)

Get detailed information associated with the user address

  1. Registration date

  2. Situation

  3. Email address

  4. 0x address

  5. Payment count

  6. Full month payment

Example Response

{ "data": { "address": "0x57ef6f871888e2d294470a0061292675f6dc309c", "email": "[email protected]", "agreementStatus": false, "agreementDate": "2023-06-08T04:53:37.812Z", "chargeTime": 2, "chargeTotal": 20 }, "message": "Success", "statusCode": 200 }

5. Get User Payment History

Endpoint

Endpoint /client/data/members/payment/{userAddress}

Parameter (Input)

Parameter
Item Name
Description

userAddress

userAddress

required

Query

Query
Item Name
Description

page

return page

default: 1 min: 1

limit

limit items to single page

default: 1 min: 1 max: 1

apiKey

api key

required

Return (Output)

Get payment information associated with the user address

  1. Payment time

  2. Payment amount

  3. Payment status

Example Response

{ "data": { "items": [ { "amount": 10, "chargedAt": "2023-06-06T08:15:34.290Z", "chargedStatus": "success" }, { "amount": 10, "chargedAt": "2023-06-06T07:34:49.734Z", "chargedStatus": "success" } ], "totalItems": 2, "page": 1, "limit": 2, "totalPages": 1 }, "message": "Success", "statusCode": 200 }

Last updated