Swagger API reference

API description for swap service

Version: V1.0

Contact information: Binance Chain

Base URL: api.binance.org/bridge

Rate Limit: 2000 request per IP per 5 mins.

/api/v1/tokens

GET

Summary: get

Parameters

Name

Located in

Description

Required

Schema

direction

query

IN or OUT

No

string

Responses

Code

Description

Schema

20000

OK

TokenList

401

Unauthorized

โ€‹

403

Forbidden

โ€‹

404

Not Found

โ€‹

/api/v1/tokens/{symbol}/networks

GET

Summary: get

Parameters

Name

Located in

Description

Required

Schema

symbol

path

token symbol

Yes

string

Responses

Code

Description

Schema

200

OK

NetworkList

401

Unauthorized

โ€‹

403

Forbidden

โ€‹

404

Not Found

โ€‹

/api/v1/swaps

GET

Summary: find swap

Parameters

Name

Located in

Description

Required

Schema

direction

query

direction

No

string

endTime

query

endTime

No

long

limit

query

limit

No

long

offset

query

offset

No

long

startTime

query

startTime

No

long

status

query

status

No

[ string ]

symbol

query

symbol

No

string

walletAddress

query

walletAddress

Yes

string

Responses

Code

Description

Schema

200

OK

ResponseStatusBodySwapList

401

Unauthorized

โ€‹

403

Forbidden

โ€‹

404

Not Found

โ€‹

POST

Summary: create

Parameters

Name

Located in

Description

Required

Schema

payload

body

payload

Yes

SwapCreationRequest

Responses

Code

Description

Schema

200

OK

ResponseStatusBodySwapCreation

201

Created

โ€‹

401

Unauthorized

โ€‹

403

Forbidden

โ€‹

404

Not Found

โ€‹

/api/v1/swaps/{swapId}

GET

Summary: get

Parameters

Name

Located in

Description

Required

Schema

swapId

path

swapId

Yes

string

Responses

Code

Description

Schema

200

OK

ResponseStatusBodySwapDetail

401

Unauthorized

โ€‹

403

Forbidden

โ€‹

404

Not Found

โ€‹

/api/v1/swaps/{swapId}/email

PUT

Summary: create Email

Parameters

Name

Located in

Description

Required

Schema

payload

body

payload

Yes

EmailUpdateRequest

swapId

path

swapId

Yes

string

Responses

Code

Description

Schema

200

OK

ResponseStatus

201

Created

โ€‹

401

Unauthorized

โ€‹

403

Forbidden

โ€‹

404

Not Found

โ€‹

/api/v1/swaps/quota/24hour

GET

Summary: getQuota

Parameters

Name

Located in

Description

Required

Schema

symbol

query

symbol

Yes

string

walletAddress

query

walletAddress

Yes

string

Responses

Code

Description

Schema

200

OK

ResponseStatusBodyQuota

401

Unauthorized

โ€‹

403

Forbidden

โ€‹

404

Not Found

โ€‹

/api/v2/swaps

GET

Summary: find swap V2

Parameters

Name

Located in

Description

Required

Schema

endTime

query

endTime

No

long

limit

query

limit

No

long

offset

query

offset

No

long

startTime

query

startTime

No

long

status

query

status

No

[ string ]

symbol

query

symbol

No

string

walletAddress

query

walletAddress

Yes

string

Responses

Code

Description

Schema

20000

OK

ResponseStatusBodySwapList

401

Unauthorized

โ€‹

403

Forbidden

โ€‹

404

Not Found

โ€‹

POST

Summary: createV2

Parameters

Name

Located in

Description

Required

Schema

payload

body

payload

Yes

SwapCreationRequestV2

Responses

Code

Description

Schema

20000

OK

ResponseStatusBodySwapCreation

20001

Created

โ€‹

401

Unauthorized

โ€‹

403

Forbidden

โ€‹

404

Not Found

โ€‹

/api/v2/tokens

GET

Summary: getQuota

Responses

Code

Description

Schema

20000

OK

TokenListV2

401

Unauthorized

โ€‹

403

Forbidden

โ€‹

404

Not Found

โ€‹

/api/v2/tokens/{symbol}/networks

GET

Summary: get

Parameters

Name

Located in

Description

Required

Schema

symbol

path

token symbol

Yes

string

Responses

Code

Description

Schema

20000

OK

NetworkListV2

401

Unauthorized

โ€‹

403

Forbidden

โ€‹

404

Not Found

โ€‹

Models

EmailUpdateRequest

Name

Type

Description

Example

email

string

โ€‹

โ€‹

walletAddress

string

โ€‹

โ€‹

ResponseStatus

Name

Type

Description

Example

code

integer

โ€‹

โ€‹

message

string

โ€‹

โ€‹

ResponseStatusBodySwapCreation

Name

Type

Description

Example

code

integer

โ€‹

โ€‹

data

SwapCreation

โ€‹

โ€‹

message

string

โ€‹

โ€‹

ResponseStatusBodySwapDetail

Name

Type

Description

Example

code

integer

โ€‹

โ€‹

data

SwapDetail

โ€‹

โ€‹

message

string

โ€‹

โ€‹

SwapCreation

Name

Type

Description

Example

amount

number

โ€‹

โ€‹

createTime

dateTime

โ€‹

โ€‹

depositAddress

string

โ€‹

โ€‹

depositAddressLabel

string

โ€‹

โ€‹

depositTimeout

dateTime

โ€‹

โ€‹

direction

string

โ€‹

โ€‹

fromNetwork

string

โ€‹

โ€‹

id

string

โ€‹

โ€‹

networkFee

number

โ€‹

โ€‹

networkFeePromoted

boolean

โ€‹

โ€‹

status

string

โ€‹

โ€‹

swapFee

number

โ€‹

โ€‹

swapFeeRate

number

โ€‹

โ€‹

symbol

string

โ€‹

โ€‹

toAddress

string

โ€‹

โ€‹

toAddressLabel

string

โ€‹

โ€‹

toNetwork

string

โ€‹

โ€‹

walletAddress

string

โ€‹

โ€‹

SwapCreationRequest

Name

Type

Description

Example

amount

number

โ€‹

โ€‹

direction

string

โ€‹

โ€‹

fromNetwork

string

โ€‹

โ€‹

source

integer

โ€‹

โ€‹

symbol

string

โ€‹

โ€‹

toAddress

string

โ€‹

โ€‹

toAddressLabel

string

โ€‹

โ€‹

toNetwork

string

โ€‹

โ€‹

walletAddress

string

โ€‹

โ€‹

SwapDetail

Name

Type

Description

Example

actualFromAmount

number

โ€‹

โ€‹

actualNetworkFee

number

โ€‹

โ€‹

actualSwapFee

number

โ€‹

โ€‹

actualToAmount

number

โ€‹

โ€‹

amount

number

โ€‹

โ€‹

createTime

dateTime

โ€‹

โ€‹

depositAddress

string

โ€‹

โ€‹

depositAddressLabel

string

โ€‹

โ€‹

depositReceivedConfirms

integer

โ€‹

โ€‹

depositRequiredConfirms

integer

โ€‹

โ€‹

depositTimeout

dateTime

โ€‹

โ€‹

depositTxId

string

โ€‹

โ€‹

depositTxLink

string

โ€‹

โ€‹

direction

string

โ€‹

โ€‹

fromNetwork

string

โ€‹

โ€‹

id

string

โ€‹

โ€‹

networkFee

number

โ€‹

โ€‹

networkFeePromoted

boolean

โ€‹

โ€‹

status

string

โ€‹

โ€‹

swapFee

number

โ€‹

โ€‹

swapFeeRate

number

โ€‹

โ€‹

swapTxId

string

โ€‹

โ€‹

swapTxLink

string

โ€‹

โ€‹

symbol

string

โ€‹

โ€‹

toAddress

string

โ€‹

โ€‹

toAddressLabel

string

โ€‹

โ€‹

toNetwork

string

โ€‹

โ€‹

updateTime

dateTime

โ€‹

โ€‹

walletAddress

string

โ€‹

โ€‹

ResponseStatusBodySwapList

Name

Type

Description

Example

code

integer

โ€‹

โ€‹

data

SwapList

โ€‹

โ€‹

message

string

โ€‹

โ€‹

SwapList

Name

Type

Description

Example

swaps

[ SwapDetail ]

โ€‹

โ€‹

total

long

โ€‹

โ€‹

TokenList

Name

Type

Description

Example

swaps

[ TokenDetail ]

โ€‹

โ€‹

total

long

โ€‹

โ€‹

TokenListV2

Name

Type

Description

Example

swaps

[ TokenDetailV2 ]

โ€‹

โ€‹

total

long

โ€‹

โ€‹

TokenDetail

Name

Type

Description

Example

name

string

โ€‹

โ€‹

symbol

string

โ€‹

โ€‹

bcSymbol

string

โ€‹

โ€‹

icon

string

โ€‹

โ€‹

minAmount

number

โ€‹

โ€‹

maxAmount

number

โ€‹

โ€‹

promotion

boolean

โ€‹

โ€‹

enabled

boolean

โ€‹

โ€‹

bscContractAddress

string

โ€‹

โ€‹

bscContractDecimal

integer

โ€‹

โ€‹

TokenDetailV2

Name

Type

Description

Example

name

string

โ€‹

โ€‹

symbol

string

โ€‹

โ€‹

bcSymbol

string

โ€‹

โ€‹

ethSymbol

string

โ€‹

โ€‹

icon

string

โ€‹

โ€‹

minAmount

number

โ€‹

โ€‹

maxAmount

number

โ€‹

โ€‹

promotion

boolean

โ€‹

โ€‹

enabled

boolean

โ€‹

โ€‹

bscContractAddress

string

โ€‹

โ€‹

bscContractDecimal

integer

โ€‹

โ€‹

ethContractAddress

string

โ€‹

โ€‹

ethContractDecimal

integer

โ€‹

โ€‹

NetworkList

Name

Type

Description

Example

from

[ NetworkDetail ]

โ€‹

โ€‹

to

[ NetworkDetail ]

โ€‹

โ€‹

NetworkDetail

Name

Type

Description

Example

name

string

โ€‹

โ€‹

supportLabel

boolean

โ€‹

โ€‹

labelName

string

โ€‹

โ€‹

labelRegex

string

โ€‹

โ€‹

txUrl

number

โ€‹

โ€‹

enabled

boolean

โ€‹

โ€‹

requiredConfirms

integer

โ€‹

โ€‹

tokenStandard

string

โ€‹

โ€‹

NetworkListV2

Name

Type

Description

Example

from

[ NetworkDetailV2 ]

โ€‹

โ€‹

to

[ NetworkDetailV2 ]

โ€‹

โ€‹

NetworkDetailV2

Name

Type

Description

Example

name

string

โ€‹

โ€‹

symbol

string

โ€‹

โ€‹

swapFeeRate

number

โ€‹

โ€‹

networkFee

number

โ€‹

โ€‹

supportLabel

boolean

โ€‹

โ€‹

labelName

string

โ€‹

โ€‹

labelRegex

string

โ€‹

โ€‹

txUrl

number

โ€‹

โ€‹

depositEnabled

boolean

โ€‹

โ€‹

withdrawEnabled

boolean

โ€‹

โ€‹

withdrawAmountUnit

number

โ€‹

โ€‹

addressRegex

string

โ€‹

โ€‹

tokenStandard

string

โ€‹

โ€‹

requiredConfirms

integer

โ€‹

โ€‹

ResponseStatusBodyQuota

Name

Type

Description

Example

code

integer

โ€‹

โ€‹

data

Quota

โ€‹

โ€‹

message

string

โ€‹

โ€‹

Quota

Name

Type

Description

Example

left

number

โ€‹

โ€‹

total

number

โ€‹

โ€‹

used

number

โ€‹

โ€‹

SwapCreationRequestV2

Name

Type

Description

Example

amount

number

โ€‹

โ€‹

fromNetwork

string

โ€‹

โ€‹

source

integer

โ€‹

โ€‹

symbol

string

โ€‹

โ€‹

toAddress

string

โ€‹

โ€‹

toAddressLabel

string

โ€‹

โ€‹

toNetwork

string

โ€‹

โ€‹

walletAddress

string

โ€‹

โ€‹

walletNetwork

string

โ€‹

โ€‹