Global

#

• postDeleteRateLimit
• postGetOrganizationByDomain
• postGetRateLimit
• postListRateLimits
• postUpdateRateLimit
• Health
  • postHealthCheck

API docs by Redocly

Web3 Cloud API (1.0.0)

Download OpenAPI specification:Download

DeleteRateLimit

delete rate limit for a chain and organisaton

Authorizations:

(x-api-keyx-api-noncex-api-signature)

Request Body schema: application/json

chain	string Chain name
organization_id required	string Unique ID of organization.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.gateway.v1.GatewayService/DeleteRateLimit

Request samples

• Payload

Content type

application/json

{

• "chain": "solana",
• "organization_id": "3f80f049-b3be-4afd-ac46-1901d43232d7"

}

Response samples

• 200
• 500

Content type

application/json

{ }

GetOrganizationByDomain

Get the organization ID corresponding to domain.

Authorizations:

(x-api-keyx-api-noncex-api-signature)

Request Body schema: application/json

domain required

string [ 1 .. 50 ] characters ^[a-z0-9]+(?:-[a-z0-9]+)*$ (Unique) Organization domain.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.gateway.v1.GatewayService/GetOrganizationByDomain

Request samples

• Payload

Content type

application/json

{

• "domain": "binance-japan"

}

Response samples

• 200
• 500

Content type

application/json

{

• "organization": {

  • "organization_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
  • "name": "Binance Japan",
  • "domain": "binance-japan",
  • "create_time": "2023-01-01T00:00:00Z",
  • "update_time": "2024-01-02T00:00:00Z"

  }

}

GetRateLimit

get rate limit for a chain and organisaton

Authorizations:

(x-api-keyx-api-noncex-api-signature)

Request Body schema: application/json

chain	string Chain name
organization_id required	string Unique ID of organization.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.gateway.v1.GatewayService/GetRateLimit

Request samples

• Payload

Content type

application/json

{

• "chain": "solana",
• "organization_id": "3f80f049-b3be-4afd-ac46-1901d43232d7"

}

Response samples

• 200
• 500

Content type

application/json

{

• "organization_id": "string",
• "ratelimit_info": {

  • "chain": "string",
  • "per_second_limit": 0,
  • "per_hour_limit": 0,
  • "per_day_limit": 0,
  • "per_month_limit": 0

  },
• "create_time": "2019-08-24T14:15:22Z",
• "update_time": "2019-08-24T14:15:22Z"

}

ListRateLimits

list rate limit for a chain and organisaton with optional filter

Authorizations:

(x-api-keyx-api-noncex-api-signature)

Request Body schema: application/json

chain	string Chain name
organization_id required	string Unique ID of organization.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.gateway.v1.GatewayService/ListRateLimit

Request samples

• Payload

Content type

application/json

{

• "chain": "solana",
• "organization_id": "3f80f049-b3be-4afd-ac46-1901d43232d7"

}

Response samples

• 200
• 500

Content type

application/json

{

• "data": [

  • {

    • "organization_id": "string",
    • "ratelimit_info": {

      • "chain": "string",
      • "per_second_limit": 0,
      • "per_hour_limit": 0,
      • "per_day_limit": 0,
      • "per_month_limit": 0

      },
    • "create_time": "2019-08-24T14:15:22Z",
    • "update_time": "2019-08-24T14:15:22Z"

    }

  ]

}

UpdateRateLimit

create or update rate limit for a chain and organisaton

Authorizations:

(x-api-keyx-api-noncex-api-signature)

Request Body schema: application/json

any

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.gateway.v1.GatewayService/UpdateRateLimit

Request samples

• Payload

Content type

application/json

null

Response samples

• 200
• 500

Content type

application/json

{ }

Health

HealthCheck

Authorizations:

(x-api-keyx-api-noncex-api-signature)

Request Body schema: application/json

object (v1HealthCheckRequest)

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.gateway.v1.GatewayService/HealthCheck

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 200
• 500

Content type

application/json

{

• "status": "SERVING_STATUS_SERVING"

}