GoPlus Security

https://docs.gopluslabs.io/
Admin
GoPlus Security is a Web3 security platform that provides real-time security intelligence APIs for...
Tokens:73,346
Snippets:586
Trust Score:9.5
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Get Available Package Response Example

Source: https://docs.gopluslabs.io/reference/get-available-package

Example response for the get_available_package endpoint. Shows a successful response with code 1 and a package object containing package_name, package_cu_size, validity_period, and price.

```json
{
  "code": 1,
  "message": "ok",
  "result": [
    {
      "package_name": "Chicken",
      "package_cu_size": "100000",
      "validity_period": "1 month",
      "price": "100"
    }
  ]
}
```

--------------------------------

### GET /v1/get_account_status Response Example

Source: https://docs.gopluslabs.io/reference/get-account-status

JSON response showing account status, overage settings, CU limits, and active package details. The response includes fields like status, overage_allowed, cu_per_minute, cu_per_day, and active_package array.

```JSON
{
  "code": 1,
  "message": "ok",
  "result": {
    "status": "active",
    "overage_allowed": 0,
    "overage_price_per_kcu": "",
    "cu_per_minute": "100",
    "cu_per_day": "100",
    "active_package": [
      {
        "package_name": "Chicken",
        "available_cu": "1000",
        "expiration_time": "2025-06-06T19:06:03+00:00",
        "renew_time": ""
      },
      {
        "package_name": "Duck",
        "available_cu": "1001",
        "expiration_time": "2025-06-06T19:12:03+00:00",
        "renew_time": ""
      }
    ]
  }
}
```

--------------------------------

### Get Available APIs Response

Source: https://docs.gopluslabs.io/reference/get-available-apis

Example response from the Get Available APIs endpoint. The result array contains API objects with fields for the API URL, documentation URL, price in CU, and batch call support (1 = supported, 0 = not supported).

```JSON
{
  "code": 1,
  "message": "ok",
  "result": [
    {
      "api": "https://api.gopluslabs.io/api/v1/token_security/{chain_id}",
      "doc": "https://docs.gopluslabs.io/reference/tokensecurityusingget_1",
      "price": "25",
      "batch_call": 1
    }
  ]
}
```

--------------------------------

### GET /v1/get_account_status Request Example

Source: https://docs.gopluslabs.io/reference/get-account-status

HTTP request to retrieve account status. Requires authentication via Authorization header with PersonalSign and X-Address header.

```HTTP
GET /v1/get_account_status HTTP/1.1
Host: api.gopluslabs.io
Authorization: PersonalSign {sign}.{timestamp}
X-Address: {ethAddress}
Accept: application/json
```

--------------------------------

### nativeBalanceChanges Example JSON

Source: https://docs.gopluslabs.io/reference/response-detail-copy-2

Example JSON response for the native_balance_changes field. Shows the address and the native_change object with before, after, and change values.

```json
{
    "native_balance_changes": [
        {
            "address": "0x0000111122223333444455556666777788889999",
            "native_change": {
                "change": "-0x100000000000000",
                "before": "0x1000000000000000000",
                "after": "0xffff00000000000000"
            }
        }
    ]
}
```

--------------------------------

### erc20BalanceChanges Example JSON

Source: https://docs.gopluslabs.io/reference/response-detail-copy-2

Example JSON response for the erc20_balance_changes field. Shows the address and an erc20_change array with token details and balance change.

```json
{
    "erc20_balance_changes": [
        {
            "address": "0xbb4cdb9cbd36b01bd1cbaebf2de08d9173bc095c",
            "erc20_change": [
              {
                  	"decimals":"0x12",
                  	"token_address": "0x68ca006db91312cd60a2238ce775be5f9f738bba",
                  	"token_name": "$ USDCGift.com",
                  	"token_symbol": "$ USDCGift.com \<- Visit to claim bonus",
                  	"change": "0x100000000000000"
              }
            ]
              }
    ]
}
```

--------------------------------

### cURL Request for get lpv3 locker infos

Source: https://docs.gopluslabs.io/reference/get-lpv3-locker-infos

Use this cURL command to call the get lpv3 locker infos endpoint. It sends a GET request to https://api.gopluslabs.io/open/api/v1/locks/lpv3s with an accept header of */*. The endpoint requires the query parameters pageNum and pageSize.

```shell
curl --request GET \
     --url https://api.gopluslabs.io/open/api/v1/locks/lpv3s \
     --header 'accept: */*'
```

--------------------------------

### LogEntry Example JSON

Source: https://docs.gopluslabs.io/reference/response-detail-copy-2

Example JSON response for the logs field in the transaction validation response. Shows the structure of a single log entry with address, topics, and data.

```json
{
    "logs": [
        {
            "address": "0xbb4cdb9cbd36b01bd1cbaebf2de08d9173bc095c",
            "topics": [
                "0xe1fffcc4923d04b559f4d29a8bfc6cda04eb5b0d3c460751c2402c5c5cc9109c",
                "0x0000000000000000000000000000111122223333444455556666777788889999"
            ],
            "data": "0x0000000000000000000000000000000000000000000000000100000000000000"
        }
    ]
}
```

--------------------------------

### cURL request to get lpv3 locker info

Source: https://docs.gopluslabs.io/reference/get-lpv3-locker-info

Sends a GET request to the lpv3 locker info endpoint with default query parameters. Requires an Authorization header in the format 'Bearer <token>'.

```shell
curl --request GET \
     --url 'https://api.gopluslabs.io/open/api/v1/locks/lpv3?chainId=56&pageNum=1&pageSize=100&poolAddress=0x579df956c6cE6178fBBD78bbE4f05786cFBA9B76' \
     --header 'accept: */*'
```

--------------------------------

### GET /api/v1/address/scan/{chain_id}

Source: https://docs.gopluslabs.io/reference/scanaddressusingget

Starts an address security scan for a given chain and address.

```APIDOC
## [GET] /api/v1/address/scan/{chain_id}

### Description
Starts an address security scan for a given chain and address.

### Method
GET

### Endpoint
https://api.gopluslabs.io/api/v1/address/scan/{chain_id}

### Parameters
#### Path Parameters
- **chain_id** (string) - Required - The chain ID.

#### Query Parameters
- **address** (string) - Required - The address to scan.

#### Headers
- **Authorization** (string) - Optional - Authorization token (e.g., `Bearer 81|9ihH8JzEuFu4MQ9DjWmH5WrNCPW...`).

### Request Example
```
curl --request GET \
     --url https://api.gopluslabs.io/api/v1/address/scan/chain_id \
     --header 'accept: */*'
```

### Response
#### Success Response (200)
OK

#### Response Example
(No example provided in the source)

#### Error Responses
- **401** Unauthorized
- **403** Forbidden
- **404** Not Found
```

--------------------------------

### Buy CU Package - HTTP Request

Source: https://docs.gopluslabs.io/reference/buy-cu-package

Use this HTTP request to purchase a CU package programmatically. The service returns an x402-encoded payment payload and redirect URL. Refer to x402 docs: https://docs.x402.org/getting-started/quickstart-for-buyers.

```HTTP
GET /api/v1/buy/{package_name} HTTP/1.1
Host: api.gopluslabs.io
Authorization: PersonalSign {sign}.{timestamp}
X-Address: {evmAddress}
Accept: application/json
```

--------------------------------

### GET /api/v1/approval_security/{chain_id}

Source: https://docs.gopluslabs.io/reference/approval-security-api-v1

This snippet documents the GET endpoint for checking approval security.

```APIDOC
## [GET] /api/v1/approval_security/{chain_id}

### Description
Get approval security information for a given chain and contract addresses.

### Method
GET

### Endpoint
https://api.gopluslabs.io/api/v1/approval_security/{chain_id}

### Parameters
#### Path Parameters
- **chain_id** (string) - Required - Chain id, (ETH: 1, BSC: 56, OKC: 66, Heco: 128, Polygon: 137, Fantom:250, Arbitrum: 42161, Avalanche: 43114)

#### Query Parameters
- **contract_addresses** (string) - Required - Contract needs to be detected

#### Headers
- **Authorization** (string) - Authorization token in the format: Bearer <token> (e.g., Bearer eyJsZXZlbCI6NSwiYXBwTmFtZSI6ImF2cyIsImFwcEtleSI6IjFaW...)

### Request Example
```
curl --request GET \
     --url https://api.gopluslabs.io/api/v1/approval_security/chain_id \
     --header 'accept: */*'
```

### Response
#### Success Response (200)
OK

#### Response Example
(No example provided)

#### Error Responses
- **401** Unauthorized
- **403** Forbidden
- **404** Not Found
```

--------------------------------

### b20_token response structure from B20.json

Source: https://docs.gopluslabs.io/reference/response-details

Example response structure for the b20_token extension field from the B20.json sample. Shows the is_b20 flag and b20_info object with risk feature entries such as mintable, transfer_pausable, owner_change_balance, metadata_modifiable, blacklist, whitelist, cannot_sell, and cannot_buy, each containing status and admin fields.

```json
"b20_token": {
  "is_b20": "1",
  "b20_info": {
    "mintable": {
      "status": "1",
      "admin": [
        "0x7cab171de20192967db420bc1d14600b6e35ab69"
      ]
    },
    "transfer_pausable": {
      "status": "1",
      "0x7cab171de20192967db420bc1d14600b6e35ab69"
    },
    "owner_change_balance": {
      "status": "1",
      "admin": [
        "0x7cab171de20192967db420bc1d14600b6e35ab69"
      ]
    },
    "metadata_modifiable": {
      "status": "0",
      "admin": [
        "0x0000000000000000000000000000000000000000"
      ]
    },
    "blacklist": {
      "status": "1",
      "admin": [
        "0x7cab171de20192967db420bc1d14600b6e35ab69"
      ]
    },
    "whitelist": {
      "status": "0",
      "admin": []
    },
    "cannot_sell": {
      "status": "1",
      "admin": []
    },
    "cannot_buy": {
      "status": "0",
      "admin": []
    }
  }
}
```

--------------------------------

### GET /v1/get_available_package Request

Source: https://docs.gopluslabs.io/reference/get-available-package

HTTP request to retrieve the list of purchasable CU packages. Requires authentication via PersonalSign and the X-Address header.

```http
GET /v1/get_available_package HTTP/1.1
Host: api.gopluslabs.io
Authorization: PersonalSign {sign}.{timestamp}
X-Address: {evmAddress}
Accept: application/json
```

--------------------------------

### GET /api/v1/buy/{package_name}

Source: https://docs.gopluslabs.io/reference/buy-cu-package

Purchase a CU package using the x402 protocol. The endpoint returns an x402-encoded payment payload and redirect URL.

```APIDOC
## GET /api/v1/buy/{package_name}

### Description
Purchase a CU package using the x402 protocol. The service returns an x402-encoded payment payload and redirect URL.

### Method
GET

### Endpoint
/api/v1/buy/{package_name}

### Parameters
#### Path Parameters
- **package_name** (string) - Required - The name of the CU package to purchase.

#### Headers
- **Authorization** (string) - Required - PersonalSign {sign}.{timestamp}
- **X-Address** (string) - Required - The EVM address of the buyer.
- **Accept** (string) - Optional - application/json

### Request Example
```
GET /api/v1/buy/{package_name} HTTP/1.1
Host: api.gopluslabs.io
Authorization: PersonalSign {sign}.{timestamp}
X-Address: {evmAddress}
Accept: application/json
```

### Response
#### Success Response (200)
- **payment** (object) - Payment details.
  - **from** (string) - Sender address.
  - **to** (string) - Recipient address.
  - **value** (string) - Payment amount.
  - **package** (string) - Package name.
  - **msg** (string) - Message.
  - **status** (integer) - Status code.
  - **timeStamp** (string) - Timestamp.
  - **description** (string) - Description.

#### Response Example
```
{
  "payment":{
    "from":"0x321448af818255c332AB4941140e2C4947400000",
    "to":"0xE32566ae10007bF988DFAc5B732184Ee197D0000",
    "value":"10000",
    "package":"basic",
    "msg":"success",
    "status":1,
    "timeStamp":"2026-03-23T21:28:49",
    "description":"now you can use your wallet to call Goplus API service ."
  }
}
```

#### Error Response
- **error** (string) - Error message.
- **details** (string) - Detailed error information.

#### Error Example
```
{
  "error": "Settlement failed",
  "details": "Transaction reverted: ERC20: transfer amount exceeds balance.. TX: 0x25747fe2fda2f3f212d51f6b093783997b80a769757501b3c179a78b83601111"
}
```
```

--------------------------------

### GET /api/v1/dapp_security

Source: https://docs.gopluslabs.io/reference/dapp-security-info-api

Get risk of dApp by URL. This endpoint accepts a URL or domain as a query parameter and returns the risk assessment. Requires an Authorization header with a Bearer token.

```APIDOC
## GET /api/v1/dapp_security

### Description
Get risk of dApp by URL.

### Method
GET

### Endpoint
https://api.gopluslabs.io/api/v1/dapp_security

### Parameters
#### Query Parameters
- **url** (string) - Required - Url or domain

#### Headers
- **Authorization** (string) - Required - Authorization token in the format: Bearer <token> (e.g., Bearer eyJsZXZlbCI6NSwiYXBwTmFtZSI6ImF2cyIsImFwcEtleSI6IjFaW...)

### Request Example
```
curl --request GET \
     --url https://api.gopluslabs.io/api/v1/dapp_security \
     --header 'accept: */*'
```

### Response
#### Success Response (200)
OK

#### Error Responses
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Not Found

```
Tokens:
Raw