postman.bitwyre.com
Open in
urlscan Pro
54.84.20.155
Public Scan
URL:
https://postman.bitwyre.com/
Submission: On October 14 via automatic, source certstream-suspicious — Scanned from DE
Submission: On October 14 via automatic, source certstream-suspicious — Scanned from DE
Form analysis 0 forms found in the DOM
Text Content
Public
Documentation Settings
Environment
DEVELOP
Layout
Double Column
Language
cURL
BITWYRE POSTMAN
* Introduction
Authentication
Admin
Private
Public
UDF
Bitwyre Postman
Authentication
Bitwyre Authentication API
Auth
Github Docs:
https://github.com/bitwyre/bitwyre/blob/develop/documentations/authentication/source/includes/_authentication.md
POST
Register
/auth/register
Bodyformdata
username
email
password
password_confirmation
nationality
referral_code
Example Request
Register
curl --location --request POST '/auth/register' \
--form 'username=""' \
--form 'email=""' \
--form 'password=""' \
--form 'password_confirmation=""' \
--form 'nationality=""' \
--form 'referral_code=""'
POST
Register Institution
/auth/register/institutional
Bodyformdata
username
legal_institution_name
email
password
password_confirmation
registration_country
Example Request
Register Institution
curl --location --request POST '/auth/register/institutional' \
--form 'username=""' \
--form 'legal_institution_name=""' \
--form 'email=""' \
--form 'password=""' \
--form 'password_confirmation=""' \
--form 'registration_country=""'
POST
Login Without OTP
/auth/login-without-otp
Bodyformdata
email
password
Example Request
Login Without OTP
curl --location --request POST '/auth/login-without-otp' \
--form 'email=""' \
--form 'password=""'
POST
Login With OTP
/auth/login-with-otp
Bodyformdata
email
password
otp_token
Example Request
Login With OTP
curl --location --request POST '/auth/login-with-otp' \
--form 'email=""' \
--form 'password=""' \
--form 'otp_token=""'
POST
Login With New IP Address
/auth/login/verify-new-ip
Bodyformdata
email
verification_code
Example Request
Login With New IP Address
curl --location --request POST '/auth/login/verify-new-ip' \
--form 'email=""' \
--form 'verification_code=""'
POST
Refresh
/auth/refresh
Bodyformdata
refresh_token
{{refersh_token}}
Example Request
Refresh
curl --location --request POST '/auth/refresh' \
--form 'refresh_token="{{refersh_token}}"'
POST
Forgot Password
/auth/forgot-password
Bodyformdata
email
Example Request
Forgot Password
curl --location --request POST '/auth/forgot-password' \
--form 'email=""'
PUT
Verify Forgot Password
/auth/reset-password
Bodyformdata
email
verification_code
Example Request
Verify Forgot Password
curl --location --request PUT '/auth/reset-password' \
--form 'email=""' \
--form 'verification_code=""'
POST
Reset Password
/auth/reset-password
Bodyformdata
email
new_password
confirm_password
Example Request
Reset Password
curl --location --request POST '/auth/reset-password' \
--form 'email=""' \
--form 'new_password=""' \
--form 'confirm_password=""'
POST
Change Password
/auth/change-password
AUTHORIZATIONBearer Token
Token
<token>
HEADERS
Authorization
Bearer •••••••
Bodyformdata
email
old_password
new_password
password_confirmation
Example Request
Change Password
curl --location --request POST '/auth/change-password' \
--header 'Authorization: Bearer ••••••• ' \
--form 'email=""' \
--form 'old_password=""' \
--form 'new_password=""' \
--form 'password_confirmation=""'
POST
Verify Email
/auth/verify-email
Bodyformdata
email
verify_code
Example Request
Verify Email
curl --location --request POST '/auth/verify-email' \
--form 'email=""' \
--form 'verify_code=""'
POST
Resend Verification Email
/auth/resend-verification
Bodyformdata
email
Example Request
Resend Verification Email
curl --location --request POST '/auth/resend-verification' \
--form 'email=""'
PUT
Activate OTP
/auth/activate-otp
HEADERS
Authorization
Bearer •••••••
Bodyformdata
Example Request
Activate OTP
curl --location --request PUT '/auth/activate-otp' \
--header 'Authorization: Bearer ••••••• '
PUT
Deactivate OTP
/auth/deactivate-otp
HEADERS
Authorization
Bearer •••••••
Bodyformdata
otp_token
Example Request
Deactivate OTP
curl --location --request PUT '/auth/deactivate-otp' \
--header 'Authorization: Bearer ••••••• ' \
--form 'otp_token=""'
POST
OTP
/auth/otp
HEADERS
Authorization
Bearer •••••••
Bodyformdata
otp_token
Example Request
OTP
curl --location --request POST '/auth/otp' \
--header 'Authorization: Bearer ••••••• ' \
--form 'otp_token=""'
POST
Challenge OTP
/auth/challenge-otp
AUTHORIZATIONBearer Token
HEADERS
Authorization
Bearer •••••••
Bodyformdata
otp_token
Example Request
Challenge OTP
curl --location --request POST '/auth/challenge-otp' \
--header 'Authorization: Bearer ••••••• ' \
--form 'otp_token=""'
POST
Forgot OTP
/auth/forgot-otp
Bodyformdata
email
Example Request
Forgot OTP
curl --location --request POST '/auth/forgot-otp' \
--form 'email=""'
PUT
Verify Forgot OTP
/auth/forgot-otp
Bodyformdata
email
verification_code
Example Request
Verify Forgot OTP
curl --location --request PUT '/auth/forgot-otp' \
--form 'email=""' \
--form 'verification_code=""'
API Keys
GET
List API Keys
/auth/keys/list
HEADERS
Authorization
Bearer •••••••
Example Request
List API Keys
curl --location --request GET '/auth/keys/list' \
--header 'Authorization: Bearer ••••••• '
POST
Generate API Key
/auth/keys/generate
HEADERS
Authorization
Bearer •••••••
Example Request
Generate API Key
curl --location --request POST '/auth/keys/generate' \
--header 'Authorization: Bearer ••••••• '
POST
Generate API Key (Read Only)
/auth/keys/generate/readonly
HEADERS
Authorization
Bearer •••••••
Example Request
Generate API Key (Read Only)
curl --location --request POST '/auth/keys/generate/readonly' \
--header 'Authorization: Bearer ••••••• '
POST
Revoke API Key
/auth/keys/revoke
HEADERS
Authorization
Bearer •••••••
Bodyformdata
api_key
Example Request
Revoke API Key
curl --location --request POST '/auth/keys/revoke' \
--header 'Authorization: Bearer ••••••• ' \
--form 'api_key=""'
PUT
Edit Permission Key
/auth/keys/permissions
HEADERS
Authorization
Bearer •••••••
Bodyformdata
api_key
enable_withdrawal
enable_read_only
Example Request
Edit Permission Key
curl --location --request PUT '/auth/keys/permissions' \
--header 'Authorization: Bearer ••••••• ' \
--form 'api_key=""' \
--form 'enable_withdrawal=""' \
--form 'enable_read_only=""'
POST
Add IP Address Whitelist
/auth/keys/ipwhitelist
HEADERS
Authorization
Bearer •••••••
Bodyformdata
api_key
ip_address
Example Request
Add IP Address Whitelist
curl --location --request POST '/auth/keys/ipwhitelist' \
--header 'Authorization: Bearer ••••••• ' \
--form 'api_key=""' \
--form 'ip_address=""'
DEL
Delete IP Address Whitelist
/auth/keys/ipwhitelist
HEADERS
Authorization
Bearer •••••••
Bodyformdata
api_key
ip_address
Example Request
Delete IP Address Whitelist
curl --location --request DELETE '/auth/keys/ipwhitelist' \
--header 'Authorization: Bearer ••••••• ' \
--form 'api_key=""' \
--form 'ip_address=""'
GET
Get IP Address Whitelist
/auth/keys/ipwhitelist
HEADERS
Authorization
Bearer •••••••
Bodyformdata
api_key
Example Request
Get IP Address Whitelist
curl --location --request GET '/auth/keys/ipwhitelist' \
--header 'Authorization: Bearer ••••••• ' \
--form 'api_key=""'
Profile
GET
Get User Profile
/auth/profile/kyclevel
HEADERS
Authorization
Bearer •••••••
Example Request
Get User Profile
curl --location --request GET '/auth/profile/kyclevel' \
--header 'Authorization: Bearer ••••••• '
GET
Get User KYC Level
/auth/profile/kyclevel
HEADERS
Authorization
Bearer •••••••
Example Request
Get User KYC Level
curl --location --request GET '/auth/profile/kyclevel' \
--header 'Authorization: Bearer ••••••• '
GET
Get User Withdrawal Fee
/auth/profile/withdrawalfee/btc
HEADERS
Authorization
Bearer •••••••
Example Request
Get User Withdrawal Fee
curl --location --request GET '/auth/profile/withdrawalfee/btc' \
--header 'Authorization: Bearer ••••••• '
GET
Get User Withdrawal Limit
/auth/profile/withdrawallimit/btc
HEADERS
Authorization
Bearer •••••••
Example Request
Get User Withdrawal Limit
curl --location --request GET '/auth/profile/withdrawallimit/btc' \
--header 'Authorization: Bearer ••••••• '
PUT
Add Preferential Pair
/auth/pair
HEADERS
Authorization
Bearer •••••••
Bodyformdata
preferential_pair
btc_usd_spot
Example Request
Add Preferential Pair
curl --location --request PUT '/auth/pair' \
--header 'Authorization: Bearer ••••••• ' \
--form 'preferential_pair="btc_usd_spot"'
GET
Get Preferential Pair
/auth/pair
HEADERS
Authorization
Bearer •••••••
Example Request
Get Preferential Pair
curl --location --request GET '/auth/pair' \
--header 'Authorization: Bearer ••••••• '
DEL
Delete Preferential Pair
/auth/pair
HEADERS
Authorization
Bearer •••••••
Bodyformdata
preferential_pair
btc_usd_spot
Example Request
Delete Preferential Pair
curl --location --request DELETE '/auth/pair' \
--header 'Authorization: Bearer ••••••• ' \
--form 'preferential_pair="btc_usd_spot"'
PUT
Set Reference Asset
/auth/asset
HEADERS
Authorization
Bearer •••••••
Bodyformdata
reference_asset
xmr
Example Request
Set Reference Asset
curl --location --request PUT '/auth/asset' \
--header 'Authorization: Bearer ••••••• ' \
--form 'reference_asset="xmr"'
DEL
Delete Reference Asset
/auth/asset
HEADERS
Authorization
Bearer •••••••
Bodyformdata
reference_asset
btc
Example Request
Delete Reference Asset
curl --location --request DELETE '/auth/asset' \
--header 'Authorization: Bearer ••••••• ' \
--form 'reference_asset="btc"'
GET
Get Friend UUID From Email
/auth/profile/test@bitwyre.com
HEADERS
Authorization
Bearer •••••••
Example Request
Get Friend UUID From Email
curl --location --request GET '/auth/profile/test@bitwyre.com' \
--header 'Authorization: Bearer ••••••• '
POST
Generate Referral Code
/auth/profile/referral-code
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"user_generated_code": true, "referral_code_type": 1, "referral_code":
"myref2"}
Example Request
Generate Referral Code
curl --location --request POST '/auth/profile/referral-code' \
--header 'Authorization: Bearer ••••••• ' \
--form 'payload="{\"user_generated_code\": true, \"referral_code_type\": 1, \"referral_code\": \"myref2\"}"'
GET
Get Referral Code
/auth/profile/referral-code
HEADERS
Authorization
Bearer •••••••
PARAMS
referral_code_type
all
Bodyformdata
Example Request
Get Referral Code
curl --location --request GET '/auth/profile/referral-code' \
--header 'Authorization: Bearer ••••••• '
DEL
Remove Referral Code
/auth/profile/referral-code
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"referral_code": "myref2"}
Example Request
Remove Referral Code
curl --location --request DELETE '/auth/profile/referral-code' \
--header 'Authorization: Bearer ••••••• ' \
--form 'payload="{\"referral_code\": \"myref2\"}"'
GET
Get Referral Code Commission History
/auth/profile/referral-code/history
HEADERS
Authorization
Bearer •••••••
PARAMS
referral_code
referral_code_bonus_type
referral_code_type
commission_asset
page
per_page
Bodyformdata
Example Request
Get Referral Code Commission History
curl --location --request GET '/auth/profile/referral-code/history' \
--header 'Authorization: Bearer ••••••• '
Friend
POST
Add Friend
/auth/friends
HEADERS
Authorization
Bearer •••••••
Bodyformdata
friend_uuid
506d6c24-0785-4069-bae9-e5bd5e6362e5
Example Request
Add Friend
curl --location --request POST '/auth/friends' \
--header 'Authorization: Bearer •••••••' \
--form 'friend_uuid="506d6c24-0785-4069-bae9-e5bd5e6362e5"'
GET
Get Friend Details
/auth/friends/506d6c24-0785-4069-bae9-e5bd5e6362e5
HEADERS
Authorization
Bearer •••••••
Example Request
Get Friend Details
curl --location --request GET '/auth/friends/506d6c24-0785-4069-bae9-e5bd5e6362e5' \
--header 'Authorization: Bearer ••••••• '
GET
Friend List
/auth/friends
HEADERS
Authorization
Bearer •••••••
Example Request
Friend List
curl --location --request GET '/auth/friends' \
--header 'Authorization: Bearer ••••••• '
PUT
Accept Friend
/auth/friends
HEADERS
Authorization
Bearer •••••••
Bodyformdata
friend_uuid
506d6c24-0785-4069-bae9-e5bd5e6362e5
action
1
Example Request
Accept Friend
curl --location --request PUT '/auth/friends' \
--header 'Authorization: Bearer ••••••• ' \
--form 'friend_uuid="506d6c24-0785-4069-bae9-e5bd5e6362e5"' \
--form 'action="1"'
PUT
Decline Friend
/auth/friends
HEADERS
Authorization
Bearer •••••••
Bodyformdata
friend_uuid
506d6c24-0785-4069-bae9-e5bd5e6362e5
action
2
Example Request
Decline Friend
curl --location --request PUT '/auth/friends' \
--header 'Authorization: Bearer ••••••• ' \
--form 'friend_uuid="506d6c24-0785-4069-bae9-e5bd5e6362e5"' \
--form 'action="2"'
PUT
Block Friend
/auth/friends
HEADERS
Authorization
Bearer •••••••
Bodyformdata
friend_uuid
506d6c24-0785-4069-bae9-e5bd5e6362e5
action
3
Example Request
Block Friend
curl --location --request PUT '/auth/friends' \
--header 'Authorization: Bearer •••••••' \
--form 'friend_uuid="506d6c24-0785-4069-bae9-e5bd5e6362e5"' \
--form 'action="3"'
DEL
Delete Friend
/auth/friends/cc26e96e-deae-45d3-914b-ae62bdb3a266
HEADERS
Authorization
Bearer •••••••
Example Request
Delete Friend
curl --location --request DELETE '/auth/friends/cc26e96e-deae-45d3-914b-ae62bdb3a266' \
--header 'Authorization: Bearer ••••••• '
Subaccount
POST
Register Subaccount
/auth/register/subaccount
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"username": "subaccount_user1", "subaccount_code":
"78838a5a-c5bc-4317-a47f-2481a92558ca"}
username: new subaccount username subaccount_code: uuid subaccount code (from
master account)
Example Request
Register Subaccount
curl --location --request POST '/auth/register/subaccount' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"username\": \"subaccount_user1\", \"subaccount_code\": \"78838a5a-c5bc-4317-a47f-2481a92558ca\"}"'
POST
Switch Account
/auth/register/switch-account
Bodyformdata
username
subaccount_test_1
subaccount username
Example Request
Switch Account
curl --location --request POST '/auth/register/switch-account' \
--form 'username="subaccount_test_1"'
GET
List Subaccount
/auth/subaccount
HEADERS
Authorization
Bearer •••••••
Bodyformdata
Example Request
List Subaccount
curl --location --request GET '/auth/subaccount' \
--header 'Authorization: Bearer ••••••• '
POST
Add Custom Login
/auth/custom-login
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"username": "subaccount_user1", "password": "passwordcl1", "login_name":
"custom_login_user1", "is_allowed_trading": 0, "is_read_only": 1}
username: Subaccount username if filled. If null Master account username is used
instead password: password for custom login login_name: username for custom
login
Example Request
Add Custom Login
curl --location --request POST '/auth/custom-login' \
--header 'Authorization: Bearer ••••••• ' \
--form 'payload="{\"username\": \"subaccount_user1\", \"password\": \"passwordcl1\", \"login_name\": \"custom_login_user1\", \"is_allowed_trading\": 0, \"is_read_only\": 1}"'
GET
List Custom Login
/auth/custom-login
HEADERS
Authorization
Bearer •••••••
Bodyformdata
Example Request
List Custom Login
curl --location --request GET '/auth/custom-login' \
--header 'Authorization: Bearer ••••••• '
DEL
Delete Custom Login
/auth/custom-login
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"login_name": "custom_login_user1"}
Example Request
Delete Custom Login
curl --location --request DELETE '/auth/custom-login' \
--header 'Authorization: Bearer ••••••• ' \
--form 'payload="{\"login_name\": \"custom_login_user1\"} "'
POST
Login With Custom
/auth/login-with-custom
Bodyformdata
email
test@gmail.com
Email username
password
passwordcl1
User custom login password (from add custom login)
login_name
custom_login_user1
Username for custom login (from add custom login)
Example Request
Login With Custom
curl --location --request POST '/auth/login-with-custom' \
--form 'email="test@gmail.com"' \
--form 'password="passwordcl1"' \
--form 'login_name="custom_login_user1"'
Admin
Auth
POST
Login Without OTP
/admin/auth/login-without-otp
Bodyformdata
email
testing_admin@bitwyre.com
password
helloworld
Example Request
Login Without OTP
curl --location --request POST '/admin/auth/login-without-otp' \
--form 'email="testing_admin@bitwyre.com"' \
--form 'password="helloworld"'
POST
Login With OTP
/admin/auth/login-with-otp
Bodyformdata
email
password
otp_token
Example Request
Login With OTP
curl --location --request POST '/admin/auth/login-with-otp' \
--form 'email=""' \
--form 'password=""' \
--form 'otp_token=""'
POST
Refresh Token
/admin/auth/refresh
Bodyformdata
refresh_token
•••••••
Example Request
Refresh Token
curl --location --request POST '/admin/auth/refresh' \
--form 'refresh_token="•••••••"'
POST
Forgot Password
/admin/auth/forgot-password
Bodyformdata
email
Example Request
Forgot Password
curl --location --request POST '/admin/auth/forgot-password' \
--form 'email=""'
POST
Change Password
/admin/auth/change-password
HEADERS
Authorization
Bearer •••••••
Bodyformdata
email
old_password
new_password
password_confirmation
Example Request
Change Password
curl --location --request POST '/admin/auth/change-password' \
--header 'Authorization: Bearer •••••••' \
--form 'email=""' \
--form 'old_password=""' \
--form 'new_password=""' \
--form 'password_confirmation=""'
POST
OTP
/admin/auth/otp
HEADERS
Authorization
Bearer •••••••
Bodyformdata
otp_token
Example Request
OTP
curl --location --request POST '/admin/auth/otp' \
--header 'Authorization: Bearer •••••••' \
--form 'otp_token=""'
PUT
Activate OTP
/admin/auth/activate-otp
HEADERS
Authorization
Bearer •••••••
Bodyformdata
Example Request
Activate OTP
curl --location --request PUT '/admin/auth/activate-otp' \
--header 'Authorization: Bearer •••••••'
PUT
Deactivate OTP
/admin/auth/deactivate-otp
HEADERS
Authorization
Bearer •••••••
Bodyformdata
otp_token
Example Request
Deactivate OTP
curl --location --request PUT '/admin/auth/deactivate-otp' \
--header 'Authorization: Bearer ••••••• ' \
--form 'otp_token=""'
POST
Challenge OTP
/admin/auth/challenge-otp
AUTHORIZATIONBearer Token
HEADERS
Authorization
Bearer •••••••
Bodyformdata
otp_token
143498
Example Request
Challenge OTP
curl --location --request POST '/admin/auth/challenge-otp' \
--header 'Authorization: Bearer •••••••' \
--form 'otp_token="143498"'
GET
Profile
/admin/auth/profile
HEADERS
Authorization
Bearer •••••••
Example Request
Profile
curl --location --request GET '/admin/auth/profile' \
--header 'Authorization: Bearer •••••••'
Admin Control
GET
Ticker
/admin/control/market/ticker?instrument=all
HEADERS
Authorization
Bearer •••••••
PARAMS
instrument
all
all for all pairs
Example Request
Ticker
curl --location --request GET '/admin/control/market/ticker?instrument=all' \
--header 'Authorization: Bearer ••••••• '
GET
Volume
/admin/control/market/volume?instrument=all
HEADERS
Authorization
Bearer •••••••
PARAMS
instrument
all
all for all pairs
Example Request
Volume
curl --location --request GET '/admin/control/market/volume?instrument=all' \
--header 'Authorization: Bearer ••••••• '
GET
Profit
/admin/control/market/profit?asset=all
HEADERS
Authorization
Bearer •••••••
PARAMS
asset
all
all for all assets
Example Request
Profit
curl --location --request GET '/admin/control/market/profit?asset=all' \
--header 'Authorization: Bearer •••••••'
GET
Total Profit
/admin/control/market/totalprofit?asset=all
HEADERS
Authorization
Bearer •••••••
PARAMS
asset
all
Example Request
Total Profit
curl --location --request GET '/admin/control/market/totalprofit?asset=all' \
--header 'Authorization: Bearer ••••••• '
GET
User Trading Fee
/admin/control/fee/trading?username=testing.bitwyre@gmail.com&instrument=all
HEADERS
Authorization
Bearer •••••••
PARAMS
username
testing.bitwyre@gmail.com
instrument
all
Example Request
User Trading Fee
curl --location --request GET '/admin/control/fee/trading?username=testing.bitwyre@gmail.com&instrument=all' \
--header 'Authorization: Bearer •••••••'
GET
Custodian Fee
/admin/control/fee/custodian?asset=all
HEADERS
Authorization
Bearer •••••••
PARAMS
asset
all
Example Request
Custodian Fee
curl --location --request GET '/admin/control/fee/custodian?asset=all' \
--header 'Authorization: Bearer •••••••'
GET
Crypto Network Fee
/admin/control/fee/network?payload={"host":"127.0.0.1","port":18332,
"rpc_username":"bitwyre", "rpc_password":"bitwyre", "asset":"btc"}
HEADERS
Authorization
Bearer •••••••
PARAMS
payload
{"host":"127.0.0.1","port":18332, "rpc_username":"bitwyre",
"rpc_password":"bitwyre", "asset":"btc"}
Example Request
Crypto Network Fee
curl --location -g --request GET '/admin/control/fee/network?payload={"host":"127.0.0.1","port":18332, "rpc_username":"bitwyre", "rpc_password":"bitwyre", "asset":"btc"}' \
--header 'Authorization: Bearer •••••••'
GET
Database Access Link
/admin/control/database?enviroment=0
HEADERS
Authorization
Bearer •••••••
PARAMS
enviroment
0
Example Request
Database Access Link
curl --location --request GET '/admin/control/database?enviroment=0' \
--header 'Authorization: Bearer •••••••'
GET
Dashboard Access Link
/admin/control/dashboard?source=0&environment=0
HEADERS
Authorization
Bearer •••••••
PARAMS
source
0
environment
0
Example Request
Dashboard Access Link
curl --location --request GET '/admin/control/dashboard?source=0&environment=0' \
--header 'Authorization: Bearer •••••••'
GET
Withdrawal Limit
/admin/control/withdrawal-limit?username=testing.bitwyre@gmail.com&asset=btc
HEADERS
Authorization
Bearer •••••••
PARAMS
username
testing.bitwyre@gmail.com
asset
btc
Example Request
Withdrawal Limit
curl --location --request GET '/admin/control/withdrawal-limit?username=testing.bitwyre@gmail.com&asset=btc' \
--header 'Authorization: Bearer •••••••'
POST
Set Contracts
/admin/control/contracts
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"instrument": , "details": , "index_price_currency": , "24h_volume_currency": ,
"contract_value": , "strike_price": , "is_option": , "is_futures": , "is_swap":
, "is_call": , "is_put": , "expiry_time": }
Example Request
Set Contracts
curl --location --request POST '/admin/control/contracts' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"instrument\": , \"details\": , \"index_price_currency\": , \"24h_volume_currency\": , \"contract_value\": , \"strike_price\": , \"is_option\": , \"is_futures\": , \"is_swap\": , \"is_call\": , \"is_put\": , \"expiry_time\": }"'
PUT
Update Contracts
/admin/control/contracts
HEADERS
Authorization
Bearer •••••••
Bodyformdata
contract_uuid
e0182b13-9771-43c8-999d-e8d26ff04a4e
payload
{"index_price": 200}
Example Request
Update Contracts
curl --location --request PUT '/admin/control/contracts' \
--header 'Authorization: Bearer •••••••' \
--form 'contract_uuid="e0182b13-9771-43c8-999d-e8d26ff04a4e"' \
--form 'payload="{\"index_price\": 200}"'
DEL
Delete Contracts
/admin/control/contracts
HEADERS
Authorization
Bearer •••••••
Bodyformdata
contract_uuid
7cd59af0-4bde-428a-af9c-f985a67f7d28
Example Request
Delete Contracts
curl --location --request DELETE '/admin/control/contracts' \
--header 'Authorization: Bearer •••••••' \
--form 'contract_uuid="7cd59af0-4bde-428a-af9c-f985a67f7d28"'
POST
Add Asset Info
/admin/control/asset-info
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
Example Request
Add Asset Info
curl --location --request POST '/admin/control/asset-info' \
--header 'Authorization: Bearer •••••••' \
--form 'payload=""'
POST
Add Instrument Info
/admin/control/instrument-info
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"instrument": "btc2_usdt_spot", "symbol": "BTC/USDT", "market": "crypto",
"product": "spot", "forbidden_country": "US"}
Example Request
Add Instrument Info
curl --location --request POST '/admin/control/instrument-info' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"instrument\": \"btc2_usdt_spot\", \"symbol\": \"BTC/USDT\", \"market\": \"crypto\", \"product\": \"spot\", \"forbidden_country\": \"US\"}"'
GET
Reconciliation
/admin/control/reconciliation
HEADERS
Authorization
Bearer •••••••
PARAMS
instrument
eth_usdt_spot
Example Request
Reconciliation
curl --location --request GET '/admin/control/reconciliation' \
--header 'Authorization: Bearer •••••••'
PUT
Update Trading Maintenance Status
/admin/control/maintenance/trading
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"instrument": "btc_idr_spot", "halt_status": 0, "reason_halt": "Test halted
all"}
Example Request
Update Trading Maintenance Status
curl --location --request PUT '/admin/control/maintenance/trading' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"instrument\": \"btc_idr_spot\", \"halt_status\": 0, \"reason_halt\": \"Test halted all\"}"'
GET
Trading Maintenance Status
/admin/control/maintenance/trading
HEADERS
Authorization
Bearer •••••••
Example Request
Trading Maintenance Status
curl --location --request GET '/admin/control/maintenance/trading' \
--header 'Authorization: Bearer •••••••'
PUT
Update Custodian Maintenance Status Copy
/admin/control/maintenance/custodian
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"asset": "all", "enabled_status": 1, "scope": 2, "reason_disabled": "Test
enabled all withdrawal"}
scope: 0 - Deposit and Withdrawal; 1 - Deposit; 2 - Withdrawal
Example Request
Update Custodian Maintenance Status Copy
curl --location --request PUT '/admin/control/maintenance/custodian' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"asset\": \"all\", \"enabled_status\": 1, \"scope\": 2, \"reason_disabled\": \"Test enabled all withdrawal\"}"'
GET
Custodian Maintenance Status
/admin/control/maintenance/custodian
HEADERS
Authorization
Bearer •••••••
Example Request
Custodian Maintenance Status
curl --location --request GET '/admin/control/maintenance/custodian' \
--header 'Authorization: Bearer ••••••• '
GET
Registered User
/admin/control/registered-user
HEADERS
Authorization
Bearer •••••••
PARAMS
instrument
eth_usdt_spot
Example Request
Registered User
curl --location --request GET '/admin/control/registered-user' \
--header 'Authorization: Bearer •••••••'
GET
Registered User Rate Volume
/admin/control/registered-user/rate/volume?instrument=eth_usdt_spot
HEADERS
Authorization
Bearer •••••••
PARAMS
instrument
eth_usdt_spot
Example Request
Registered User Rate Volume
curl --location --request GET '/admin/control/registered-user/rate/volume?instrument=eth_usdt_spot' \
--header 'Authorization: Bearer •••••••'
GET
Information Fees
/admin/control/information-fee?asset=eth
HEADERS
Authorization
Bearer •••••••
PARAMS
asset
eth
Example Request
Information Fees
curl --location --request GET '/admin/control/information-fee?asset=eth' \
--header 'Authorization: Bearer •••••••'
GET
Trading Volume
/admin/control/trading-volume
HEADERS
Authorization
Bearer •••••••
PARAMS
instrument
btc_usdt_spot
all for all pairs
period
all
daily, weekly, monthly, yearly, all_time, all
Example Request
Trading Volume
curl --location --request GET '/admin/control/trading-volume' \
--header 'Authorization: Bearer •••••••'
GET
Information Custodian
/admin/control/information-custodian?asset=btc
HEADERS
Authorization
Bearer •••••••
PARAMS
asset
btc
all for all pairs
Example Request
Information Custodian
curl --location --request GET '/admin/control/information-custodian?asset=btc' \
--header 'Authorization: Bearer •••••••'
POST
Send Email Report to Shareholders
/admin/control/shareholder-report
HEADERS
Authorization
Bearer •••••••
Example Request
Send Email Report to Shareholders
curl --location --request POST '/admin/control/shareholder-report' \
--header 'Authorization: Bearer •••••••'
GET
Get UDF Info
/admin/control/udf-info?symbol=btc_usdt_spot
HEADERS
Authorization
Bearer •••••••
PARAMS
symbol
btc_usdt_spot
Example Request
Get UDF Info
curl --location --request GET '/admin/control/udf-info?symbol=btc_usdt_spot' \
--header 'Authorization: Bearer •••••••'
PUT
Update UDF Info
/admin/control/udf-info
HEADERS
Authorization
Bearer •••••••
Bodyformdata
symbol
btc_usdt_spot
payload
{"currency_code": "USDT"}
Example Request
Update UDF Info
curl --location --request PUT '/admin/control/udf-info' \
--header 'Authorization: Bearer •••••••' \
--form 'symbol="btc_usdt_spot"' \
--form 'payload="{\"currency_code\": \"USDT\"}"'
DEL
Remove UDF Info
/admin/control/udf-info
HEADERS
Authorization
Bearer •••••••
Bodyformdata
symbol
btc_usdt_spot
Example Request
Remove UDF Info
curl --location --request DELETE '/admin/control/udf-info' \
--header 'Authorization: Bearer •••••••' \
--form 'symbol="btc_usdt_spot"'
Market Control
PUT
Halt/Unhalt Market Trading
/admin/market/halt
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"instrument" : "btc_usdt_spot", "is_halt":0}
Example Request
Halt/Unhalt Market Trading
curl --location --request PUT '/admin/market/halt' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"instrument\" : \"btc_usdt_spot\", \"is_halt\":0}"'
POST
Reset Market Orderbook
/admin/market/reset
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"instrument":"all"}
pairs or all
Example Request
Reset Market Orderbook
curl --location --request POST '/admin/market/reset' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"instrument\":\"all\"}"'
GET
Halted Market Status
/admin/market/halt
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"instrument":"all"}
pairs or all
Example Request
Halted Market Status
curl --location --request GET '/admin/market/halt' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"instrument\":\"all\"}"'
GET
Orderbooks Data
/admin/market/orderbooks?instrument=btc_usdt_spot&depth_num=150&use_snapshot=False
HEADERS
Authorization
Bearer •••••••
PARAMS
instrument
btc_usdt_spot
Optional. If None, use all instruments
depth_num
150
Optional. If None, use 150 (max)
use_snapshot
False
Optional. If None, use False
Bodyformdata
Example Request
Orderbooks Data
curl --location --request GET '/admin/market/orderbooks?instrument=btc_usdt_spot&depth_num=150&use_snapshot=False' \
--header 'Authorization: Bearer •••••••'
POST
Insert Orderbooks/Snapshot Data
/admin/market/orderbooks
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"use_snapshot": false, "instrument": "btc_usdt_spot", "price_level": "71000",
"orderbook_type": "ask", "quantity": "0.1", "timestamp": 1636507425593722000,
"last_order_uuid": "a202babc-f535-4653-b255-0985377deb47", "last_sequence": 5}
use_snapshot: Required. Value = bool (true/false) instrument: Required. Value =
str (supported pairs) price_level: Required. Value = str (non-zero)
orderbook_type. Required. Value = str (ask/bid) quantity: Required. Value = str
(>0) timestamp: Required. Value = int timestamp (ns) last_sequence: Required.
Only used if use_snapshot is False. Value = int last_order_uuid: Optional. Only
used if use_snapshot is False. Value = str (uuid4)
Example Request
Insert Orderbooks/Snapshot Data
curl --location --request POST '/admin/market/orderbooks' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"use_snapshot\": false, \"instrument\": \"btc_usdt_spot\", \"price_level\": \"71000\", \"orderbook_type\": \"ask\", \"quantity\": \"0.1\", \"timestamp\": 1636507425593722000, \"last_order_uuid\": \"a202babc-f535-4653-b255-0985377deb47\", \"last_sequence\": 5}"'
PUT
Update Orderbooks/Snapshot Data
/admin/market/orderbooks
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"use_snapshot": false, "instrument": "btc_usdt_spot", "price_level": "71000",
"orderbook_type": "ask", "quantity": "0.5555", "timestamp": 1636507425593722000,
"last_order_uuid": "a202babc-f535-4653-b255-0985377deb47", "last_sequence": 99}
use_snapshot: Required. Value = bool (true/false) instrument. Required. Value =
str (supported pairs) price_level. Required. Value = str (non-zero)
orderbook_type. Required. Value = str (ask/bid) Payload also must include at
least one of:
1. quantity. Value = str (>0)
2. timestamp. Value = int timestamp (ns) If use_snapshot is false, it also can
include:
3. last_order_uuid. Optional. Value = str (uuid4)
4. last_sequence. Value = int
Example Request
Update Orderbooks/Snapshot Data
curl --location --request PUT '/admin/market/orderbooks' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"use_snapshot\": false, \"instrument\": \"btc_usdt_spot\", \"price_level\": \"71000\", \"orderbook_type\": \"ask\", \"quantity\": \"0.5555\", \"timestamp\": 1636507425593722000, \"last_order_uuid\": \"a202babc-f535-4653-b255-0985377deb47\", \"last_sequence\": 99}"'
DEL
Delete Orderbooks/Snapshot Data
/admin/market/orderbooks
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"use_snapshot": false, "instrument": "btc_usdt_spot", "price_level": "71000",
"orderbook_type": "ask"}
use_snapshot: Required. Value = bool (true/false) instrument. Required. Value =
str (supported pairs) price_level. Required. Value = str (non-zero)
orderbook_type. Required. Value = str (ask/bid)
Example Request
Delete Orderbooks/Snapshot Data
curl --location --request DELETE '/admin/market/orderbooks' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"use_snapshot\": false, \"instrument\": \"btc_usdt_spot\", \"price_level\": \"71000\", \"orderbook_type\": \"ask\"}"'
POST
ME CLI Command
/admin/market/command-line
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"command": 0, "instrument": "btc_usdt_spot", "order_uuid": ""}
Example Request
ME CLI Command
curl --location --request POST '/admin/market/command-line' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"command\": 0, \"instrument\": \"btc_usdt_spot\", \"order_uuid\": \"\"}"'
Custodian Control
GET
Deposit Status
/admin/custodian/deposit/1952e311-cfc9-412e-9ff3-e5cb8131ed45
HEADERS
Authorization
Bearer •••••••
Bodyformdata
Example Request
Deposit Status
curl --location --request GET '/admin/custodian/deposit/1952e311-cfc9-412e-9ff3-e5cb8131ed45' \
--header 'Authorization: Bearer •••••••'
GET
Withdrawal Status
/admin/custodian/withdrawal/1952e311-cfc9-412e-9ff3-e5cb8131ed45
HEADERS
Authorization
Bearer •••••••
Example Request
Withdrawal Status
curl --location --request GET '/admin/custodian/withdrawal/1952e311-cfc9-412e-9ff3-e5cb8131ed45' \
--header 'Authorization: Bearer •••••••'
PUT
Custodian Halt/Unhalt
/admin/custodian/halt
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"asset" : "btc", "type":2, "is_halt":0}
type: 1 - Deposit; 2 - Withdrawal
Example Request
Custodian Halt/Unhalt
curl --location --request PUT '/admin/custodian/halt' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"asset\" : \"btc\", \"type\":2, \"is_halt\":0}"'
PUT
Upload Approval Withdrawal
/admin/custodian/approved
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"asset" : "btc"}
file
Example Request
Upload Approval Withdrawal
curl --location --request PUT '/admin/custodian/approved' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"asset\" : \"btc\"}"' \
--form 'file=@"/path/to/file"'
GET
View Wallet Balance
/admin/custodian/wallet?payload={"host":"127.0.0.1","port":18232,
"rpc_username":"bitwyre", "rpc_password":"bitwyre", "asset":"zec"}
HEADERS
Authorization
Bearer •••••••
PARAMS
payload
{"host":"127.0.0.1","port":18232, "rpc_username":"bitwyre",
"rpc_password":"bitwyre", "asset":"zec"}
Example Request
View Wallet Balance
curl --location -g --request GET '/admin/custodian/wallet?payload={"host":"127.0.0.1","port":18232, "rpc_username":"bitwyre", "rpc_password":"bitwyre", "asset":"zec"}' \
--header 'Authorization: Bearer •••••••'
PUT
Set Custodian Fee
/admin/custodian/fee
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"asset" : "btc", "fee": 1}
Example Request
Set Custodian Fee
curl --location --request PUT '/admin/custodian/fee' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"asset\" : \"btc\", \"fee\": 1}"'
GET
All Withdrawal Requests
/admin/custodian/withdrawal/all
HEADERS
Authorization
Bearer •••••••
PARAMS
status
Pending
Example Request
All Withdrawal Requests
curl --location --request GET '/admin/custodian/withdrawal/all' \
--header 'Authorization: Bearer •••••••'
PUT
Approve Withdrawal Request
/admin/custodian/withdrawal/rejected/4b6dc35a-ab03-4f55-bb81-8efb5a8569e1
HEADERS
Authorization
Bearer •••••••
Example Request
Approve Withdrawal Request
curl --location --request PUT '/admin/custodian/withdrawal/rejected/4b6dc35a-ab03-4f55-bb81-8efb5a8569e1' \
--header 'Authorization: Bearer •••••••'
DEL
Reject Withdrawal Request
/admin/custodian/withdrawal/rejected/4b6dc35a-ab03-4f55-bb81-8efb5a8569e1
HEADERS
Authorization
Bearer •••••••
Example Request
Reject Withdrawal Request
curl --location --request DELETE '/admin/custodian/withdrawal/rejected/4b6dc35a-ab03-4f55-bb81-8efb5a8569e1' \
--header 'Authorization: Bearer •••••••'
POST
Execute Approved Withdrawal Request
/admin/custodian/withdrawal/executed/628b6842-bba8-4846-9756-17ba6b5ef5a6
HEADERS
Authorization
Bearer •••••••
Example Request
Execute Approved Withdrawal Request
curl --location --request POST '/admin/custodian/withdrawal/executed/628b6842-bba8-4846-9756-17ba6b5ef5a6' \
--header 'Authorization: Bearer •••••••'
User Control
GET
All Users Info
/admin/users
HEADERS
Authorization
Bearer •••••••
Example Request
All Users Info
curl --location --request GET '/admin/users' \
--header 'Authorization: Bearer •••••••'
GET
View User Info
/admin/user/info?username=testing.bitwyre@gmail.com&scope=0
HEADERS
Authorization
Bearer •••••••
PARAMS
username
testing.bitwyre@gmail.com
scope
0
0 = KYC; 1 = Transaction History; 2 = Order History; 3 = Deposit History; 4 =
Withdrawal History; 5 = Profiles
Example Request
View User Info
curl --location --request GET '/admin/user/info?username=testing.bitwyre@gmail.com&scope=0' \
--header 'Authorization: Bearer •••••••'
POST
Set KYC
/admin/user/set-kyc-data
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"username": "testing.bitwyre@gmail.com", "name”: "Test User 1",
"place_of_birth": "Jakarta", "date_of_birth": "1995-07-03", "gender": "Male",
"phone_number": "+62 81254782072", "address": "Jl. Medan Merdeka, Central
Jakarta", "province": "Jakarta", "city": "Jakarta", "postcode": "12652",
"identity_card_type": "KTP", "identity_card_number": "31384398934239",
"nationality": "ID", "selfie_photo_url":
"https://storage.bitwyre.com/assets/selfie.png", "identity_card_scan_url":
"https://storage.bitwyre.com/assets/selfie.png"}
Example Request
Set KYC
curl --location --request POST '/admin/user/set-kyc-data' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"username\": \"testing.bitwyre@gmail.com\", \"name”: \"Test User 1\", \"place_of_birth\": \"Jakarta\", \"date_of_birth\": \"1995-07-03\", \"gender\": \"Male\", \"phone_number\": \"+62 81254782072\", \"address\": \"Jl. Medan Merdeka, Central Jakarta\", \"province\": \"Jakarta\", \"city\": \"Jakarta\", \"postcode\": \"12652\", \"identity_card_type\": \"KTP\", \"identity_card_number\": \"31384398934239\", \"nationality\": \"ID\", \"selfie_photo_url\": \"https://storage.bitwyre.com/assets/selfie.png\", \"identity_card_scan_url\": \"https://storage.bitwyre.com/assets/selfie.png\"}"'
PUT
Update KYC
/admin/user/set-kyc-data
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"username": "testing.bitwyre@gmail.com", "name”: "Test User 1",
"place_of_birth": "Jakarta", "date_of_birth": "1995-07-03", "gender": "Male",
"phone_number": "+62 81254782072", "address": "Jl. Medan Merdeka, Central
Jakarta", "province": "Jakarta", "city": "Jakarta", "postcode": "12652",
"identity_card_type": "KTP", "identity_card_number": "31384398934239",
"nationality": "ID", "selfie_photo_url":
"https://storage.bitwyre.com/assets/selfie.png", "identity_card_scan_url":
"https://storage.bitwyre.com/assets/selfie.png"}
Example Request
Update KYC
curl --location --request PUT '/admin/user/set-kyc-data' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"username\": \"testing.bitwyre@gmail.com\", \"name”: \"Test User 1\", \"place_of_birth\": \"Jakarta\", \"date_of_birth\": \"1995-07-03\", \"gender\": \"Male\", \"phone_number\": \"+62 81254782072\", \"address\": \"Jl. Medan Merdeka, Central Jakarta\", \"province\": \"Jakarta\", \"city\": \"Jakarta\", \"postcode\": \"12652\", \"identity_card_type\": \"KTP\", \"identity_card_number\": \"31384398934239\", \"nationality\": \"ID\", \"selfie_photo_url\": \"https://storage.bitwyre.com/assets/selfie.png\", \"identity_card_scan_url\": \"https://storage.bitwyre.com/assets/selfie.png\"}"'
PUT
Ban/Unban User
/admin/user/ban
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"username" : "testing.bitwyre@gmail.com", "is_restricted":0}
Example Request
Ban/Unban User
curl --location --request PUT '/admin/user/ban' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"username\" : \"testing.bitwyre@gmail.com\", \"is_restricted\":0}"'
GET
Get Banned User
/admin/user/ban?username
HEADERS
Authorization
Bearer •••••••
PARAMS
username
Bodyformdata
Example Request
Get Banned User
curl --location --request GET '/admin/user/ban?username' \
--header 'Authorization: Bearer •••••••'
GET
View KYC/AML Submission
/admin/user/kyc-submission?username=testing.bitwyre@gmail.com
HEADERS
Authorization
Bearer •••••••
PARAMS
username
testing.bitwyre@gmail.com
Example Request
View KYC/AML Submission
curl --location --request GET '/admin/user/kyc-submission?username=testing.bitwyre@gmail.com' \
--header 'Authorization: Bearer •••••••'
PUT
Upgrade KYC/AML Level
/admin/user/upgrade-kyc
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"username" : "testing.bitwyre@gmail.com", "kyc_level":1}
Example Request
Upgrade KYC/AML Level
curl --location --request PUT '/admin/user/upgrade-kyc' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"username\" : \"testing.bitwyre@gmail.com\", \"kyc_level\":1}"'
PUT
Set Withdrawal Limit
/admin/user/withdrawal-limit
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"username" : "testing.bitwyre@gmail.com", "amount":"1000", "asset":"usd"}
Example Request
Set Withdrawal Limit
curl --location --request PUT '/admin/user/withdrawal-limit' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"username\" : \"testing.bitwyre@gmail.com\", \"amount\":\"1000\", \"asset\":\"usd\"}"'
PUT
Set User Trading Fee
/admin/user/fee
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"username":"testing.bitwyre@gmail.com", "taker_fee": "0.01", "maker_fee":
"0.01", "instrument": "btc_idr_spot"}
Example Request
Set User Trading Fee
curl --location --request PUT '/admin/user/fee' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"username\":\"testing.bitwyre@gmail.com\", \"taker_fee\": \"0.01\", \"maker_fee\": \"0.01\", \"instrument\": \"btc_idr_spot\"}"'
POST
Admin Deposit
/admin/user/deposit
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"amount" : "1000", "email":"testing.bitwyre@gmail.com", "asset": "idr",
"type":"fiat", "address":"12345", "tx_id":"54331", "provider": "arta graha"}
Example Request
Admin Deposit
curl --location --request POST '/admin/user/deposit' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"amount\" : \"1000\", \"email\":\"testing.bitwyre@gmail.com\", \"asset\": \"idr\", \"type\":\"fiat\", \"address\":\"12345\", \"tx_id\":\"54331\", \"provider\": \"arta graha\"}"'
GET
Get Forgot Password Request
/admin/user/forgot-password-request?email=testing.bitwyre@gmail
HEADERS
Authorization
Bearer •••••••
PARAMS
email
testing.bitwyre@gmail
Bodyformdata
Example Request
Get Forgot Password Request
curl --location --request GET '/admin/user/forgot-password-request?email=testing.bitwyre@gmail' \
--header 'Authorization: Bearer •••••••'
POST
Approve Forgot Password Request
/admin/user/forgot-password-request
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"email": , "verification_uuid": }
Example Request
Approve Forgot Password Request
curl --location --request POST '/admin/user/forgot-password-request' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"email\": , \"verification_uuid\": }"'
PUT
Reject Forgot Password Request
/admin/user/forgot-password-request
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"email": , "verification_uuid": }
Example Request
Reject Forgot Password Request
curl --location --request PUT '/admin/user/forgot-password-request' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"email\": , \"verification_uuid\": }"'
DEL
Delete Forgot Password Request
/admin/user/forgot-password-request
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"email": , "verification_uuid": }
Example Request
Delete Forgot Password Request
curl --location --request DELETE '/admin/user/forgot-password-request' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"email\": , \"verification_uuid\": }"'
GET
Get Forgot OTP Request
/admin/user/forgot-otp-request
HEADERS
Authorization
Bearer •••••••
PARAMS
email
testing.bitwyre@gmail.com
Bodyformdata
Example Request
Get Forgot OTP Request
curl --location --request GET '/admin/user/forgot-otp-request' \
--header 'Authorization: Bearer •••••••'
POST
Approve Forgot OTP Request
/admin/user/forgot-otp-request
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"email": "testing.bitwyre@gmail.com", "verification_uuid":
"ec3ac65e-541c-4cb4-b03c-81eb24d9db5a"}
Example Request
Approve Forgot OTP Request
curl --location --request POST '/admin/user/forgot-otp-request' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"email\": \"testing.bitwyre@gmail.com\", \"verification_uuid\": \"ec3ac65e-541c-4cb4-b03c-81eb24d9db5a\"}"'
PUT
Reject Forgot OTP Request
/admin/user/forgot-otp-request
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"email": "testing2.bitwyre@gmail.com", "verification_uuid":
"a1db7c2c-726d-4d0b-a38a-e189137c2b37"}
Example Request
Reject Forgot OTP Request
curl --location --request PUT '/admin/user/forgot-otp-request' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"email\": \"testing2.bitwyre@gmail.com\", \"verification_uuid\": \"a1db7c2c-726d-4d0b-a38a-e189137c2b37\"}"'
DEL
Delete Forgot OTP Request
/admin/user/forgot-otp-request
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"email": "testing4.bitwyre@gmail.com", "verification_uuid":
"43db7c2c-146d-013b-z42d-e084333c2b30"}
Example Request
Delete Forgot OTP Request
curl --location --request DELETE '/admin/user/forgot-otp-request' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"email\": \"testing4.bitwyre@gmail.com\", \"verification_uuid\": \"43db7c2c-146d-013b-z42d-e084333c2b30\"}"'
POST
Insert Spot Balance
/admin/user/spotbalance
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"email": "testing.bitwyre@gmail.com", "asset": "btc", "locked_balance": "0",
"available_balance": "0.1", "total_balance": "0.1"}
Example Request
Insert Spot Balance
curl --location --request POST '/admin/user/spotbalance' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"email\": \"testing.bitwyre@gmail.com\", \"asset\": \"btc\", \"locked_balance\": \"0\", \"available_balance\": \"0.1\", \"total_balance\": \"0.1\"}"'
PUT
Operation Spot Balance
/admin/user/spotbalance
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"email": "testing.bitwyre@gmail.com", "asset": "btc", "locked_balance": "0",
"available_balance": "0.1", "total_balance": "0.1"}
Example Request
Operation Spot Balance
curl --location --request PUT '/admin/user/spotbalance' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"email\": \"testing.bitwyre@gmail.com\", \"asset\": \"btc\", \"locked_balance\": \"0\", \"available_balance\": \"0.1\", \"total_balance\": \"0.1\"}"'
GET
Get Spot Balance
/admin/user/spotbalance?email=testing.bitwyre@gmail.com
HEADERS
Authorization
Bearer •••••••
PARAMS
email
testing.bitwyre@gmail.com
Bodyformdata
Example Request
Get Spot Balance
curl --location --request GET '/admin/user/spotbalance?email=testing.bitwyre@gmail.com' \
--header 'Authorization: Bearer •••••••'
POST
Insert Derivatives Balance
/admin/user/derivativesbalance
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"email": "testing.bitwyre@gmail.com", "asset": "btc", "locked_balance": "0",
"available_balance": "0.1", "total_balance": "0.1"}
Example Request
Insert Derivatives Balance
curl --location --request POST '/admin/user/derivativesbalance' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"email\": \"testing.bitwyre@gmail.com\", \"asset\": \"btc\", \"locked_balance\": \"0\", \"available_balance\": \"0.1\", \"total_balance\": \"0.1\"}"'
PUT
Operation Derivatives Balance
/admin/user/derivativesbalance
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"email": "testing.bitwyre@gmail.com", "asset": "btc", "locked_balance": "0",
"available_balance": "0.1", "total_balance": "0.1"}
Example Request
Operation Derivatives Balance
curl --location --request PUT '/admin/user/derivativesbalance' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"email\": \"testing.bitwyre@gmail.com\", \"asset\": \"btc\", \"locked_balance\": \"0\", \"available_balance\": \"0.1\", \"total_balance\": \"0.1\"}"'
GET
Get Derivatives Balance
/admin/user/derivativesbalance?email=testing.bitwyre@gmail.com
HEADERS
Authorization
Bearer •••••••
PARAMS
email
testing.bitwyre@gmail.com
Bodyformdata
Example Request
Get Derivatives Balance
curl --location --request GET '/admin/user/derivativesbalance?email=testing.bitwyre@gmail.com' \
--header 'Authorization: Bearer •••••••'
POST
Set User Rate Limit
/admin/user/ratelimit
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"username": "test", "rate_limit": 1000}
Example Request
Set User Rate Limit
curl --location --request POST '/admin/user/ratelimit' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"username\": \"test\", \"rate_limit\": 1000}"'
PUT
Update User Rate Limit
/admin/user/ratelimit
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"username": "test", "rate_limit": 100}
Example Request
Update User Rate Limit
curl --location --request PUT '/admin/user/ratelimit' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"username\": \"test\", \"rate_limit\": 100}"'
GET
Get User Rate Limit
/admin/user/ratelimit?username
HEADERS
Authorization
Bearer •••••••
PARAMS
username
Bodyformdata
Example Request
Get User Rate Limit
curl --location --request GET '/admin/user/ratelimit?username' \
--header 'Authorization: Bearer •••••••'
GET
Get KYC Files
/admin/user/kycfiles?payload={"email": "testing.bitwyre@gmail.com", "fileclass":
1}
HEADERS
Authorization
Bearer •••••••
PARAMS
payload
{"email": "testing.bitwyre@gmail.com", "fileclass": 1}
Bodyformdata
Example Request
Get KYC Files
curl --location -g --request GET '/admin/user/kycfiles?payload={"email": "testing.bitwyre@gmail.com", "fileclass": 1}' \
--header 'Authorization: Bearer •••••••'
PUT
Mark KYC Files as Deleted
/admin/user/kycfiles
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"email": "testing.bitwyre@gmail.com", "fileclass": 1}
Example Request
Mark KYC Files as Deleted
curl --location --request PUT '/admin/user/kycfiles' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"email\": \"testing.bitwyre@gmail.com\", \"fileclass\": 1}"'
GET
Get Fiat Deposit Proof Files
/admin/user/depositproofiles?payload={"email": "testing.bitwyre@gmail.com"}
HEADERS
Authorization
Bearer •••••••
PARAMS
payload
{"email": "testing.bitwyre@gmail.com"}
Bodyformdata
Example Request
Get Fiat Deposit Proof Files
curl --location -g --request GET '/admin/user/depositproofiles?payload={"email": "testing.bitwyre@gmail.com"}' \
--header 'Authorization: Bearer •••••••'
PUT
Mark Fiat Deposit Proof Files as Deleted
/admin/user/depositproofiles
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"email": "testing.bitwyre@gmail.com", "file_uuid":
"99c038cd-819f-4200-9d88-dbfc71519020"}
Example Request
Mark Fiat Deposit Proof Files as Deleted
curl --location --request PUT '/admin/user/depositproofiles' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"email\": \"testing.bitwyre@gmail.com\", \"file_uuid\": \"99c038cd-819f-4200-9d88-dbfc71519020\"}"'
Private
Bitwyre Private API
Official Docs: https://docs.bitwyre.id/#private-api
Github Docs:
https://github.com/bitwyre/bitwyre/blob/develop/documentations/trading/source/includes/_private.md
Spot
GET
Spot Account Balance
/private/account/spotbalance
HEADERS
Authorization
Bearer •••••••
PARAMS
asset
btc
use_pagination
page
per_page
Example Request
Spot Account Balance
curl --location --request GET '/private/account/spotbalance' \
--header 'Authorization: Bearer ••••••• '
POST
Moving Account Balance to Derivatives
/private/account/spotbalance
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"asset": "", "amount": ""}
Example Request
Moving Account Balance to Derivatives
curl --location --request POST '/private/account/spotbalance' \
--header 'Authorization: Bearer ••••••• ' \
--form 'payload="{\"asset\": \"\", \"amount\": \"\"}"'
GET
Account Statement
/private/account/statement?page&per_page
HEADERS
Authorization
Bearer •••••••
PARAMS
page
per_page
Bodyformdata
payload
{"assets": [""]}
Example Request
Account Statement
curl --location --request GET '/private/account/statement?page&per_page' \
--header 'Authorization: Bearer ••••••• ' \
--form 'payload="{\"assets\": [\"\"]}"'
GET
User Withdrawal Fees
/private/account/fees/withdrawal
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"asset": ""}
Example Request
User Withdrawal Fees
curl --location --request GET '/private/account/fees/withdrawal' \
--header 'Authorization: Bearer ••••••• ' \
--form 'payload="{\"asset\": \"\"}"'
GET
Transaction Histories
/private/account/transactions?type&asset&page&per_page
HEADERS
Authorization
Bearer •••••••
PARAMS
type
asset
page
per_page
Example Request
Transaction Histories
curl --location --request GET '/private/account/transactions?type&asset&page&per_page' \
--header 'Authorization: Bearer ••••••• '
GET
Order Quantity Percentage
/private/orders/qty-percentage?order_type=2&order_side=1&price=yeet&instrument=btc_usdt_spot
HEADERS
Authorization
Bearer •••••••
PARAMS
order_type
2
1 - Market; 2 - Limit
order_side
1
1 - Buy; 2 - Sell
price
yeet
instrument
btc_usdt_spot
Example Request
Order Quantity Percentage
curl --location --request GET '/private/orders/qty-percentage?order_type=2&order_side=1&price=yeet&instrument=btc_usdt_spot' \
--header 'Authorization: Bearer ••••••• '
POST
Create a New Open Order
/private/orders
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"instrument": "btc_usdt_spot", "side": 1, "ordtype": 2, "stoppx": "",
"orderqty": "1", "price":"10000"}
"side" : buy (1) or sell (2), "ordtype": market (1), limit (2), stop (3), or
stop_limit (4)
Example Request
Create a New Open Order
curl --location --request POST '/private/orders' \
--header 'Authorization: Bearer ••••••• ' \
--form 'payload="{\"instrument\": \"btc_usdt_spot\", \"side\": 1, \"ordtype\": 2, \"stoppx\": \"\", \"orderqty\": \"1\", \"price\":\"10000\"}"'
GET
Open Orders
/private/orders/open?payload={"instrument":"btc_usdt_spot", "from_time":
1593487780108470000, "to_time": 1593487786824088000}
HEADERS
Authorization
Bearer •••••••
PARAMS
payload
{"instrument":"btc_usdt_spot", "from_time": 1593487780108470000, "to_time":
1593487786824088000}
Bodyformdata
Example Request
Open Orders
curl --location -g --request GET '/private/orders/open?payload={"instrument":"btc_usdt_spot", "from_time": 1593487780108470000, "to_time": 1593487786824088000}' \
--header 'Authorization: Bearer ••••••• '
GET
Open Orders (All)
/private/orders/open/all
HEADERS
Authorization
Bearer •••••••
Bodyformdata
Example Request
Open Orders (All)
curl --location --request GET '/private/orders/open/all' \
--header 'Authorization: Bearer ••••••• '
GET
Closed Orders
/private/orders/closed?payload={"instrument":"btc_usd_spot"}
HEADERS
Authorization
Bearer •••••••
PARAMS
payload
{"instrument":"btc_usd_spot"}
Bodyformdata
Example Request
Closed Orders
curl --location -g --request GET '/private/orders/closed?payload={"instrument":"btc_usd_spot"}' \
--header 'Authorization: Bearer ••••••• '
GET
Closed Orders (All)
/private/orders/closed/all
HEADERS
Authorization
Bearer •••••••
Example Request
Closed Orders (All)
curl --location --request GET '/private/orders/closed/all' \
--header 'Authorization: Bearer ••••••• '
GET
Canceled Orders (All)
/private/orders/cancelled
HEADERS
Authorization
Bearer •••••••
Bodyformdata
Example Request
Canceled Orders (All)
curl --location --request GET '/private/orders/cancelled' \
--header 'Authorization: Bearer ••••••• '
GET
Order Info
/private/orders/info/25cc91e7-3506-4dab-b589-aa2add22ba5e
HEADERS
Authorization
Bearer •••••••
Example Request
Order Info
curl --location --request GET '/private/orders/info/25cc91e7-3506-4dab-b589-aa2add22ba5e' \
--header 'Authorization: Bearer ••••••• '
GET
Order Info (All)
/private/orders/info/all
HEADERS
Authorization
Bearer •••••••
Example Request
Order Info (All)
curl --location --request GET '/private/orders/info/all' \
--header 'Authorization: Bearer ••••••• '
GET
Order Histories
/private/orders/histories?payload={"instrument":"btc_usdt_spot", "from_time":
1593487780108470000, "to_time": 1693487786824088000}
HEADERS
Authorization
Bearer •••••••
PARAMS
payload
{"instrument":"btc_usdt_spot", "from_time": 1593487780108470000, "to_time":
1693487786824088000}
Bodyformdata
Example Request
Order Histories
curl --location -g --request GET '/private/orders/histories?payload={"instrument":"btc_usdt_spot", "from_time": 1593487780108470000, "to_time": 1693487786824088000}' \
--header 'Authorization: Bearer ••••••• '
GET
Order Histories (All)
/private/orders/histories
HEADERS
Authorization
Bearer •••••••
Bodyformdata
Example Request
Order Histories (All)
curl --location --request GET '/private/orders/histories' \
--header 'Authorization: Bearer ••••••• '
GET
Order Journey
/private/orders/journey?payload={"order_id": 4219}
HEADERS
Authorization
Bearer •••••••
PARAMS
payload
{"order_id": 4219}
Bodyformdata
Example Request
Order Journey
curl --location -g --request GET '/private/orders/journey?payload={"order_id": 4219}' \
--header 'Authorization: Bearer ••••••• '
DEL
Cancel Orders
/private/orders/cancel
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"order_ids": ["f5d28368-6438-47ce-a4b1-95162dd1df29"], "qtys": [1.0]}
Example Request
Cancel Orders
curl --location --request DELETE '/private/orders/cancel' \
--header 'Authorization: Bearer ••••••• ' \
--form 'payload="{\"order_ids\": [\"f5d28368-6438-47ce-a4b1-95162dd1df29\"], \"qtys\": [1.0]}"'
DEL
Cancel Orders (All)
/private/orders/cancel
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"order_ids": [], "qtys":[]}
Example Request
Cancel Orders (All)
curl --location --request DELETE '/private/orders/cancel' \
--header 'Authorization: Bearer ••••••• ' \
--form 'payload="{\"order_ids\": [], \"qtys\":[]}"'
DEL
Cancel Orders (Instrument)
/private/orders/cancel/instrument/btc_usdt_spot
HEADERS
Authorization
Bearer •••••••
Bodyformdata
Example Request
Cancel Orders (Instrument)
curl --location --request DELETE '/private/orders/cancel/instrument/btc_usdt_spot' \
--header 'Authorization: Bearer ••••••• '
DEL
Close an Open Position
/private/positions/close
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"position_ids": ["f5d28368-6438-47ce-a4b1-95162dd1df29"]}
Example Request
Close an Open Position
curl --location --request DELETE '/private/positions/close' \
--header 'Authorization: Bearer ••••••• ' \
--form 'payload="{\"position_ids\": [\"f5d28368-6438-47ce-a4b1-95162dd1df29\"]}"'
DEL
Close Open Positions (Instrument)
/private/positions/close/instrument/btcusdx_perp_futures
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"position_ids": ["f5d28368-6438-47ce-a4b1-95162dd1df29"]}
Example Request
Close Open Positions (Instrument)
curl --location --request DELETE '/private/positions/close/instrument/btcusdx_perp_futures' \
--header 'Authorization: Bearer ••••••• ' \
--form 'payload="{\"position_ids\": [\"f5d28368-6438-47ce-a4b1-95162dd1df29\"]}"'
GET
Trade History
/private/trades
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"instrument": "btc_usdt_spot", "count": 5, "from_time": 1606334066242329000,
"to_time": 1626334066242329000}
Example Request
Trade History
curl --location --request GET '/private/trades' \
--header 'Authorization: Bearer ••••••• ' \
--form 'payload="{\"instrument\": \"btc_usdt_spot\", \"count\": 5, \"from_time\": 1606334066242329000, \"to_time\": 1626334066242329000}"'
GET
Trade History (All)
/private/trades
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{}
Example Request
Trade History (All)
curl --location --request GET '/private/trades' \
--header 'Authorization: Bearer ••••••• ' \
--form 'payload="{}"'
GET
Get Trading Notifications
/private/account/notifications/trading?trading_notification_type=all&limit=1
HEADERS
Authorization
Bearer •••••••
PARAMS
trading_notification_type
all
TradingNotificationType enum. Default all
limit
1
Positive integer. Default 100 (max)
Example Request
Get Trading Notifications
curl --location --request GET '/private/account/notifications/trading?trading_notification_type=all&limit=1' \
--header 'Authorization: Bearer ••••••• '
GET
Search Favorites
/private/favorites?instruments=["btc_usdt_spot"]
HEADERS
Authorization
Bearer •••••••
PARAMS
instruments
["btc_usdt_spot"]
Bodyformdata
Example Request
Search Favorites
curl --location -g --request GET '/private/favorites?instruments=["btc_usdt_spot"]' \
--header 'Authorization: Bearer ••••••• '
GET
Get Preferential Pairs
/private/pairs
HEADERS
Authorization
Bearer •••••••
Bodyformdata
Example Request
Get Preferential Pairs
curl --location --request GET '/private/pairs' \
--header 'Authorization: Bearer ••••••• '
PUT
Add Preferential Pairs
/private/pairs?payload={"instruments": ["btc_usdt_spot"]}
HEADERS
Authorization
Bearer •••••••
PARAMS
payload
{"instruments": ["btc_usdt_spot"]}
Bodyformdata
Example Request
Add Preferential Pairs
curl --location -g --request PUT '/private/pairs?payload={"instruments": ["btc_usdt_spot"]}' \
--header 'Authorization: Bearer ••••••• '
DEL
Remove Preferential Pairs
/private/pairs?payload={"instruments": ["btc_usdt_spot"]}
HEADERS
Authorization
Bearer •••••••
PARAMS
payload
{"instruments": ["btc_usdt_spot"]}
Bodyformdata
Example Request
Remove Preferential Pairs
curl --location -g --request DELETE '/private/pairs?payload={"instruments": ["btc_usdt_spot"]}' \
--header 'Authorization: Bearer •••••••'
GET
Get Instrument Details
/private/instrument/details
HEADERS
Authorization
Bearer •••••••
PARAMS
instrument
product
market
country
Bodyformdata
Example Request
Get Instrument Details
curl --location --request GET '/private/instrument/details' \
--header 'Authorization: Bearer ••••••• '
Derivatives
GET
Derivatives Account Balance
/private/account/derivativesbalance?page&per_page
HEADERS
Authorization
Bearer •••••••
PARAMS
page
per_page
Example Request
Derivatives Account Balance
curl --location --request GET '/private/account/derivativesbalance?page&per_page' \
--header 'Authorization: Bearer ••••••• '
POST
Moving Account Balance to Spot
/private/account/derivativesbalance
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"asset": "", "amount": ""}
Example Request
Moving Account Balance to Spot
curl --location --request POST '/private/account/derivativesbalance' \
--header 'Authorization: Bearer ••••••• ' \
--form 'payload="{\"asset\": \"\", \"amount\": \"\"}"'
GET
Open Derivatives Positions
/private/positions/open
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"instrument": "", "from_time": 1, "to_time": 3}
Example Request
Open Derivatives Positions
curl --location --request GET '/private/positions/open' \
--header 'Authorization: Bearer ••••••• ' \
--form 'payload="{\"instrument\": \"\", \"from_time\": 1, \"to_time\": 3}"'
GET
Open Derivatives Positions (All)
/private/positions/open/all
HEADERS
Authorization
Bearer •••••••
Bodyformdata
Example Request
Open Derivatives Positions (All)
curl --location --request GET '/private/positions/open/all' \
--header 'Authorization: Bearer ••••••• '
GET
Closed Derivatives Positions
/private/positions/closed
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"instrument": "", "from_time": 1, "to_time": 3}
Example Request
Closed Derivatives Positions
curl --location --request GET '/private/positions/closed' \
--header 'Authorization: Bearer ••••••• ' \
--form 'payload="{\"instrument\": \"\", \"from_time\": 1, \"to_time\": 3}"'
GET
Closed Derivatives Positions (All)
/private/positions/closed/all
HEADERS
Authorization
Bearer •••••••
Bodyformdata
Example Request
Closed Derivatives Positions (All)
curl --location --request GET '/private/positions/closed/all' \
--header 'Authorization: Bearer ••••••• '
GET
Derivatives Position Info
/private/position/info/18ef82be-1656-487e-9e87-99fdec376906
HEADERS
Authorization
Bearer •••••••
Bodyformdata
Example Request
Derivatives Position Info
curl --location --request GET '/private/position/info/18ef82be-1656-487e-9e87-99fdec376906' \
--header 'Authorization: Bearer ••••••• '
Custodian
POST
Create a New Crypto Withdrawal Request
/private/account/withdrawal/crypto
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"asset": "eth", "amount":"0.01", "address":"", "network_id": "ETH"}
Example Request
Create a New Crypto Withdrawal Request
curl --location --request POST '/private/account/withdrawal/crypto' \
--header 'Authorization: Bearer ••••••• ' \
--form 'payload="{\"asset\": \"eth\", \"amount\":\"0.01\", \"address\":\"\", \"network_id\": \"ETH\"}"'
GET
Verify Crypto Withdrawal Request
/private/account/withdrawal/crypto/verify/c0f100e4-d017-4f4f-9f01-5ca55f44dd82/638d9367-f751-49ca-94e0-d769dcc879be
HEADERS
Authorization
Bearer •••••••
Example Request
Verify Crypto Withdrawal Request
curl --location --request GET '/private/account/withdrawal/crypto/verify/c0f100e4-d017-4f4f-9f01-5ca55f44dd82/638d9367-f751-49ca-94e0-d769dcc879be' \
--header 'Authorization: Bearer ••••••• '
GET
Crypto Withdrawal Request Status
/private/account/withdrawal/crypto/btc/c0f100e4-d017-4f4f-9f01-5ca55f44dd82
HEADERS
Authorization
Bearer •••••••
Example Request
Crypto Withdrawal Request Status
curl --location --request GET '/private/account/withdrawal/crypto/btc/c0f100e4-d017-4f4f-9f01-5ca55f44dd82' \
--header 'Authorization: Bearer ••••••• '
POST
Creating a New Fiat Withdrawal Request
/private/account/withdrawal/fiat
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"asset": "idr", "amount":10000, "notes": "bayar utang",
"address":"thisisaddress", "provider": "bank"}
Example Request
Creating a New Fiat Withdrawal Request
curl --location --request POST '/private/account/withdrawal/fiat' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"asset\": \"idr\", \"amount\":10000, \"notes\": \"bayar utang\", \"address\":\"thisisaddress\", \"provider\": \"bank\"}"'
GET
Verify Fiat Withdrawal Request
/private/account/withdrawal/fiat/verify/7c50f1af-0964-4a88-b172-70087123ef10/ead2959d-e6e9-40b3-8e1f-3cfa73909f10
HEADERS
Authorization
Bearer •••••••
Example Request
Verify Fiat Withdrawal Request
curl --location --request GET '/private/account/withdrawal/fiat/verify/7c50f1af-0964-4a88-b172-70087123ef10/ead2959d-e6e9-40b3-8e1f-3cfa73909f10' \
--header 'Authorization: Bearer •••••••'
GET
Fiat Withdrawal Request Status
/private/account/withdrawal/fiat/idr/7c50f1af-0964-4a88-b172-70087123ef10
HEADERS
Authorization
Bearer •••••••
Example Request
Fiat Withdrawal Request Status
curl --location --request GET '/private/account/withdrawal/fiat/idr/7c50f1af-0964-4a88-b172-70087123ef10' \
--header 'Authorization: Bearer •••••••'
POST
Get a New Crypto Deposit Address
/private/account/deposit/crypto
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"asset": "sol"}
Example Request
Get a New Crypto Deposit Address
curl --location --request POST '/private/account/deposit/crypto' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"asset\": \"sol\"}"'
GET
Crypto Deposit Address History
/private/account/deposit/crypto/usdt/0xAe088D50cc3154F450e6B4673daa64b4C075C0D1
HEADERS
Authorization
Bearer •••••••
Example Request
Crypto Deposit Address History
curl --location --request GET '/private/account/deposit/crypto/usdt/0xAe088D50cc3154F450e6B4673daa64b4C075C0D1' \
--header 'Authorization: Bearer •••••••'
GET
Crypto Deposit Address History (All)
/private/account/deposit/crypto/btc/all
HEADERS
Authorization
Bearer •••••••
Example Request
Crypto Deposit Address History (All)
curl --location --request GET '/private/account/deposit/crypto/btc/all' \
--header 'Authorization: Bearer ••••••• '
GET
Get New Fiat Deposit Address
/private/account/deposit/fiat/idr
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"asset": "idr"}
Example Request
Get New Fiat Deposit Address
curl --location --request GET '/private/account/deposit/fiat/idr' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"asset\": \"idr\"}"'
GET
Fiat Deposit Address History
/private/account/deposit/fiat/idr/n1LfPc9TsgqfbnpTL6iodt9v84RLujiiDF
HEADERS
Authorization
Bearer •••••••
Example Request
Fiat Deposit Address History
curl --location --request GET '/private/account/deposit/fiat/idr/n1LfPc9TsgqfbnpTL6iodt9v84RLujiiDF' \
--header 'Authorization: Bearer •••••••'
GET
Fiat Deposit Address History (All)
/private/account/deposit/fiat/idr/all
HEADERS
Authorization
Bearer •••••••
Example Request
Fiat Deposit Address History (All)
curl --location --request GET '/private/account/deposit/fiat/idr/all' \
--header 'Authorization: Bearer ••••••• '
DEL
Cancel Pending Crypto Withdrawal
/private/account/withdrawal/crypto/btc/170eba83-c5f4-48a6-ab18-1d7c4115d709
HEADERS
Authorization
Bearer •••••••
Example Request
Cancel Pending Crypto Withdrawal
curl --location --request DELETE '/private/account/withdrawal/crypto/btc/170eba83-c5f4-48a6-ab18-1d7c4115d709' \
--header 'Authorization: Bearer •••••••'
DEL
Cancel Pending Crypto Withdrawal (All)
/private/account/withdrawal/crypto/btc/all
HEADERS
Authorization
Bearer •••••••
Example Request
Cancel Pending Crypto Withdrawal (All)
curl --location --request DELETE '/private/account/withdrawal/crypto/btc/all' \
--header 'Authorization: Bearer •••••••' \
--data-raw ''
DEL
Cancel Pending Fiat Withdrawal
/private/account/withdrawal/fiat/usd/1c0ef4c7-c9ac-42e8-894f-c53551911082
HEADERS
Authorization
Bearer •••••••
Example Request
Cancel Pending Fiat Withdrawal
curl --location --request DELETE '/private/account/withdrawal/fiat/usd/1c0ef4c7-c9ac-42e8-894f-c53551911082' \
--header 'Authorization: Bearer •••••••' \
--data-raw ''
DEL
Cancel Pending Fiat Withdrawal All (All)
/private/account/withdrawal/fiat/usd/all
HEADERS
Authorization
Bearer •••••••
Example Request
Cancel Pending Fiat Withdrawal All (All)
curl --location --request DELETE '/private/account/withdrawal/fiat/usd/all' \
--header 'Authorization: Bearer •••••••' \
--data-raw ''
GET
Get Withdrawal Addresses
/private/account/withdrawal/crypto/address
HEADERS
Authorization
Bearer •••••••
Example Request
Get Withdrawal Addresses
curl --location --request GET '/private/account/withdrawal/crypto/address' \
--header 'Authorization: Bearer •••••••'
PUT
Add Withdrawal Address
/private/account/withdrawal/crypto/address
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"asset": "btc", "address": "3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5",
"address_name": "mybtcaddress1"}
Example Request
Add Withdrawal Address
curl --location --request PUT '/private/account/withdrawal/crypto/address' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"asset\": \"btc\", \"address\": \"3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5\", \"address_name\": \"mybtcaddress1\"}"'
DEL
Delete Withdrawal Address
/private/account/withdrawal/crypto/address
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"asset": "btc", "address": "3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5"}
Example Request
Delete Withdrawal Address
curl --location --request DELETE '/private/account/withdrawal/crypto/address' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"asset\": \"btc\", \"address\": \"3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5\"}"'
POST
Verify Withdrawal Address
/private/account/withdrawal/crypto/address
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"asset": "btc", "address": "3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5",
"withdrawal_confirmation_uuid": "c2025d42-e0c6-47a4-9f0f-bdc627983163"}
Example Request
Verify Withdrawal Address
curl --location --request POST '/private/account/withdrawal/crypto/address' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"asset\": \"btc\", \"address\": \"3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5\", \"withdrawal_confirmation_uuid\": \"c2025d42-e0c6-47a4-9f0f-bdc627983163\"}"'
PATCH
Resend Verification Withdrawal Address
/private/account/withdrawal/crypto/address
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"asset": "btc", "address": "3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5"}
Example Request
Resend Verification Withdrawal Address
curl --location --request PATCH '/private/account/withdrawal/crypto/address' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"asset\": \"btc\", \"address\": \"3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5\"}"'
GET
Get Banking Details
/private/account/banking/idr
HEADERS
Authorization
Bearer •••••••
Example Request
Get Banking Details
curl --location --request GET '/private/account/banking/idr' \
--header 'Authorization: Bearer ••••••• '
POST
Set Banking Details
/private/account/banking
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"bank_name": "JP Morgan Chase", "swift_code": "CHASUSXX", "bank_account":
12345678, "bank_account_name": "Satoshi Nakamoto", "address": "23 Embarcadero
Road, California, USA", "details": "routing code XXXXX", "account_nickname":
"Nakamoto Chase Account", "asset":"idr"}
Example Request
Set Banking Details
curl --location --request POST '/private/account/banking' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"bank_name\": \"JP Morgan Chase\", \"swift_code\": \"CHASUSXX\", \"bank_account\": 12345678, \"bank_account_name\": \"Satoshi Nakamoto\", \"address\": \"23 Embarcadero Road, California, USA\", \"details\": \"routing code XXXXX\", \"account_nickname\": \"Nakamoto Chase Account\", \"asset\":\"idr\"}"'
GET
Getting List of Deposit Payment Gateways
/private/account/deposit/gateway?payload={"asset": "usd"}
HEADERS
Authorization
Bearer •••••••
PARAMS
payload
{"asset": "usd"}
Example Request
Getting List of Deposit Payment Gateways
curl --location -g --request GET '/private/account/deposit/gateway?payload={"asset": "usd"}' \
--header 'Authorization: Bearer •••••••'
GET
Getting List of Withdrawal Payment Gateways
/private/account/withdrawal/gateway?payload={"asset": "usd"}
HEADERS
Authorization
Bearer •••••••
PARAMS
payload
{"asset": "usd"}
Example Request
Getting List of Withdrawal Payment Gateways
curl --location -g --request GET '/private/account/withdrawal/gateway?payload={"asset": "usd"}' \
--header 'Authorization: Bearer •••••••'
KYC/AML
GET
Get KYC Data Status
/private/account/kyc-data/status
HEADERS
Authorization
Bearer •••••••
Bodyformdata
Example Request
Get KYC Data Status
curl --location --request GET '/private/account/kyc-data/status' \
--header 'Authorization: Bearer •••••••'
POST
Submit KYC Data
/private/account/kyc-data
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"name": "Test User", "address": "MyAddress1", "id_card_number": "AB12345",
"id_card_type": 0, "id_card_country_code": "ID"}
id_card_type: 0 - National Identity; 1 - Driving License; 2 - Passport; 99 -
Others id_card_country_code: ISO 3166-1 alpha-2
Example Request
Submit KYC Data
curl --location --request POST '/private/account/kyc-data' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"name\": \"Test User\", \"address\": \"MyAddress1\", \"id_card_number\": \"AB12345\", \"id_card_type\": 0, \"id_card_country_code\": \"ID\"}"'
PUT
Update Rejected KYC Data
/private/account/kyc-data
HEADERS
Authorization
Bearer •••••••
Bodyformdata
rejection_reason
1
0 - InvalidID; 1 - InvalidSelfie; 2 - InvalidData; 3 - InvalidIDAndSelfie; 4 -
InvalidIDAndData; 5 - InvalidSelfieAndData; 6 - InvalidAll
payload
{"name": "Test User 2", "address": "MyAddress2", "id_card_number": "AB12346",
"id_card_type": 0, "id_card_country_code": "ID"}
Required only if rejection_reason contains InvalidData
Example Request
Update Rejected KYC Data
curl --location --request PUT '/private/account/kyc-data' \
--header 'Authorization: Bearer •••••••' \
--form 'rejection_reason="1"' \
--form 'payload="{\"name\": \"Test User 2\", \"address\": \"MyAddress2\", \"id_card_number\": \"AB12346\", \"id_card_type\": 0, \"id_card_country_code\": \"ID\"}"'
POST
Upload KYC Files
/private/uploadkycfiles
HEADERS
Authorization
Bearer •••••••
Bodyformdata
type
1
file
Example Request
Upload KYC Files
curl --location --request POST '/private/uploadkycfiles' \
--header 'Authorization: Bearer •••••••' \
--form 'type="1"' \
--form 'file=@"/path/to/file"'
POST
Upload KYC Files (Mobile)
/private/uploadkycfiles-mobile
HEADERS
Authorization
Bearer •••••••
Bodyformdata
type
{"withdrawal_id": , "centralized_confirmation": }
file
Example Request
Upload KYC Files (Mobile)
curl --location --request POST '/private/uploadkycfiles-mobile' \
--header 'Authorization: Bearer •••••••' \
--form 'type="{\"withdrawal_id\": , \"centralized_confirmation\": }"' \
--form 'file=@"/path/to/file"'
POST
Upload Fiat Deposit Proof
/private/account/withdrawal/fiat/uploadproof
HEADERS
Authorization
Bearer •••••••
Bodyformdata
transaction_id
file
Example Request
Upload Fiat Deposit Proof
curl --location --request POST '/private/account/withdrawal/fiat/uploadproof' \
--header 'Authorization: Bearer •••••••' \
--form 'transaction_id=""' \
--form 'file=@"/path/to/file"'
POST
Upload Fiat Deposit Proof (Mobile)
/private/account/withdrawal/fiat/uploadproof
HEADERS
Authorization
Bearer •••••••
Bodyformdata
transaction_id
file
Example Request
Upload Fiat Deposit Proof (Mobile)
curl --location --request POST '/private/account/withdrawal/fiat/uploadproof' \
--header 'Authorization: Bearer •••••••' \
--form 'transaction_id=""' \
--form 'file=@"/path/to/file"'
GET
Get Support Tickets
/private/support/ticket?page&per_page
HEADERS
Authorization
Bearer •••••••
PARAMS
page
per_page
Bodyformdata
Example Request
Get Support Tickets
curl --location --request GET '/private/support/ticket?page&per_page' \
--header 'Authorization: Bearer •••••••'
POST
Create Support Tickets
/private/support/ticket
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"issue_type": 1, "priority": 1, "subject": "", "description": ""}
file
Example Request
Create Support Tickets
curl --location --request POST '/private/support/ticket' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"issue_type\": 1, \"priority\": 1, \"subject\": \"\", \"description\": \"\"}"' \
--form 'file=@"/path/to/file"'
POST
Upload Identity
/private/upload_identity
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"type": ""}
file
image file (.png or .jpg)
Example Request
Upload Identity
curl --location --request POST '/private/upload_identity' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"type\": \"\"}"' \
--form 'file=@"/path/to/file"'
POST
Upload Selfie
/private/upload_selfie
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"type": }
file
Example Request
Upload Selfie
curl --location --request POST '/private/upload_selfie' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"type\": }"' \
--form 'file=@"/path/to/file"'
Convert
POST
Request Convert
/private/convert
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"from_coin": "btc", "to_coin": "usdt", "size": "0.1"}
Example Request
Request Convert
curl --location --request POST '/private/convert' \
--header 'Authorization: Bearer ••••••• ' \
--form 'payload="{\"from_coin\": \"btc\", \"to_coin\": \"usdt\", \"size\": \"0.1\"}"'
GET
Get Convert Details
/private/convert?convert_uuid
HEADERS
Authorization
Bearer •••••••
PARAMS
convert_uuid
Example Request
Get Convert Details
curl --location --request GET '/private/convert?convert_uuid' \
--header 'Authorization: Bearer •••••••'
GET
Get Convert Payment Methods
/private/convert/payment_methods?type=all
HEADERS
Authorization
Bearer •••••••
PARAMS
type
all
fiat, crypto or all
Example Request
Get Convert Payment Methods
curl --location --request GET '/private/convert/payment_methods?type=all' \
--header 'Authorization: Bearer •••••••'
GET
Get Convert Status
/private/convert/status?convert_uuid
HEADERS
Authorization
Bearer •••••••
PARAMS
convert_uuid
Example Request
Get Convert Status
curl --location --request GET '/private/convert/status?convert_uuid' \
--header 'Authorization: Bearer •••••••'
POST
Create Convert Vault
/private/convert/vault
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"asset": "btc", "network_id": "BTC_TEST", "convert_uuid":
"4eff0605-d341-417f-be49-d0409b5766cf"}
Example Request
Create Convert Vault
curl --location --request POST '/private/convert/vault' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"asset\": \"btc\", \"network_id\": \"BTC_TEST\", \"convert_uuid\": \"4eff0605-d341-417f-be49-d0409b5766cf\"}"'
PUT
Set Convert URL Callback
/private/convert/callback
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"callback_url": ""}
Example Request
Set Convert URL Callback
curl --location --request PUT '/private/convert/callback' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"callback_url\": \"\"}"'
PUT
Set Deposit URL Callback
/private/deposit/callback
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"callback_url": ""}
Example Request
Set Deposit URL Callback
curl --location --request PUT '/private/deposit/callback' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"callback_url\": \"\"}"'
GET
Get Convert Deposit Info
/private/convert/vault?asset&network_id&convert_uuid&address&tx_id&page&per_page
HEADERS
Authorization
Bearer •••••••
PARAMS
asset
network_id
convert_uuid
address
tx_id
page
per_page
Example Request
Get Convert Deposit Info
curl --location --request GET '/private/convert/vault?asset&network_id&convert_uuid&address&tx_id&page&per_page' \
--header 'Authorization: Bearer •••••••'
Subaccount
POST
Transfer Balance Master Subaccount
/private/account/spotbalance/transfer-master-subaccounts
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"username_destination": "subaccount_1", "asset": "btc", "amount": "0.001"}
Example Request
Transfer Balance Master Subaccount
curl --location --request POST '/private/account/spotbalance/transfer-master-subaccounts' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"username_destination\": \"subaccount_1\", \"asset\": \"btc\", \"amount\": \"0.001\"}"'
Others
POST
Send Chat Message
/private/chat
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"message" : "Hmmmms", "counterparty": "505feb81-cb13-4f1e-94da-54ee0c42efaf"}
Example Request
Send Chat Message
curl --location --request POST '/private/chat' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"message\" : \"Hmmmms\", \"counterparty\": \"505feb81-cb13-4f1e-94da-54ee0c42efaf\"}"'
GET
Get Chat History
/private/chat/list?payload={"counterparty":
"9c399705-6469-47c6-8715-8dd9bf5c81f7", "limit": 5}
HEADERS
Authorization
Bearer •••••••
PARAMS
payload
{"counterparty": "9c399705-6469-47c6-8715-8dd9bf5c81f7", "limit": 5}
Example Request
Get Chat History
curl --location -g --request GET '/private/chat/list?payload={"counterparty": "9c399705-6469-47c6-8715-8dd9bf5c81f7", "limit": 5}' \
--header 'Authorization: Bearer •••••••'
GET
Get Chat History with Limit
/private/chat?payload={"counterparty": "9c399705-6469-47c6-8715-8dd9bf5c81f7"}
HEADERS
Authorization
Bearer •••••••
PARAMS
payload
{"counterparty": "9c399705-6469-47c6-8715-8dd9bf5c81f7"}
Example Request
Get Chat History with Limit
curl --location -g --request GET '/private/chat?payload={"counterparty": "9c399705-6469-47c6-8715-8dd9bf5c81f7"}' \
--header 'Authorization: Bearer •••••••'
GET
Search Chat Message
/private/chat/search?payload={"messsage": "something that I forgot"}
HEADERS
Authorization
Bearer •••••••
PARAMS
payload
{"messsage": "something that I forgot"}
Bodyformdata
Example Request
Search Chat Message
curl --location -g --request GET '/private/chat/search?payload={"messsage": "something that I forgot"}' \
--header 'Authorization: Bearer •••••••'
POST
Send Escrow Request
/private/escrow
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"base_asset": , "base_asset_amount": , "quote_asset": , "quote_asset_amount": ,
"counterparty": }
Example Request
Send Escrow Request
curl --location --request POST '/private/escrow' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"base_asset\": , \"base_asset_amount\": , \"quote_asset\": , \"quote_asset_amount\": , \"counterparty\": }"'
PUT
Accept Escrow Request
/private/escrow
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"escrow_id": }
Example Request
Accept Escrow Request
curl --location --request PUT '/private/escrow' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"escrow_id\": }"'
DEL
Decline Escrow Request
/private/escrow
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"escrow_id": }
Example Request
Decline Escrow Request
curl --location --request DELETE '/private/escrow' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"escrow_id\": }"'
GET
Escrow History
/private/escrow/pending
HEADERS
Authorization
Bearer •••••••
Example Request
Escrow History
curl --location --request GET '/private/escrow/pending' \
--header 'Authorization: Bearer •••••••'
GET
Escrow History (All)
/private/escrow/all
HEADERS
Authorization
Bearer •••••••
Example Request
Escrow History (All)
curl --location --request GET '/private/escrow/all' \
--header 'Authorization: Bearer •••••••'
GET
Escrow History Pending
/private/escrow/e4ghoiufnsnoj
HEADERS
Authorization
Bearer •••••••
Example Request
Escrow History Pending
curl --location --request GET '/private/escrow/e4ghoiufnsnoj' \
--header 'Authorization: Bearer •••••••'
POST
Send Forum Posts
/private/forum
HEADERS
Authorization
Bearer •••••••
Bodyformdata
payload
{"post": , "tagged": }
Example Request
Send Forum Posts
curl --location --request POST '/private/forum' \
--header 'Authorization: Bearer •••••••' \
--form 'payload="{\"post\": , \"tagged\": }"'
GET
Get Forum Posts
/private/forum?payload={"poster": , "tagged": , "from_time": , "to_time": }
HEADERS
Authorization
Bearer •••••••
PARAMS
payload
{"poster": , "tagged": , "from_time": , "to_time": }
Example Request
Get Forum Posts
curl --location -g --request GET '/private/forum?payload={"poster": , "tagged": , "from_time": , "to_time": }' \
--header 'Authorization: Bearer •••••••'
Public
Bitwyre Public API
Official Docs: https://docs.bitwyre.id/#public-api
Github Docs:
https://github.com/bitwyre/bitwyre/blob/develop/documentations/trading/source/includes/_public.md
GET
Server Time
/public/time
Returns server's time.
Example Request
Server Time
curl --location --request GET '/public/time'
GET
Markets
/public/markets
Returns an underscore _ delimited tradable markets array.
Example Request
Markets
curl --location --request GET '/public/markets'
GET
Products
/public/products
Returns an underscore _ delimited tradable products array.
Example Request
Products
curl --location --request GET '/public/products'
GET
Assets
/public/assets
Returns an array filled with supported assets.
Example Request
Assets
curl --location --request GET '/public/assets'
GET
Crypto Assets
/public/assets/crypto
Returns an array filled with supported crypto assets.
Example Request
Crypto Assets
curl --location --request GET '/public/assets/crypto'
GET
Fiat Assets
/public/assets/fiat
Returns an array filled with supported fiat assets.
Example Request
Fiat Assets
curl --location --request GET '/public/assets/fiat'
GET
Instruments
/public/pairs?market=crypto&product=spot&country=ID
Returns an underscore _ delimited tradable asset pairs array.
PARAMS
market
crypto
product
spot
country
ID
Bodyformdata
Example Request
Instruments
curl --location --request GET '/public/pairs?market=crypto&product=spot&country=ID'
GET
Ticker
/public/ticker
Returns ticker information for an asset pair.
PARAMS
instrument
btc_usd_spot
Optional
Example Request
Ticker
curl --location --request GET '/public/ticker'
GET
Trades
/public/trades?trade_num=1&instrument=btc_usdt_spot
Returns last trade_num trades for an asset pair.
PARAMS
trade_num
1
instrument
btc_usdt_spot
Example Request
Trades
curl --location --request GET '/public/trades?trade_num=1&instrument=btc_usdt_spot'
GET
Depth
/public/depth?instrument=btc_usd_spot&depth_num=1
Returns depth data for an asset pair.
PARAMS
instrument
btc_usd_spot
Optional
depth_num
1
Max. 150
Example Request
Depth
curl --location --request GET '/public/depth?instrument=btc_usd_spot&depth_num=1'
GET
Contract
/public/contract?instrument=btcusdtx_usdt_210430F70000000000
Returns contract details for a derivative instrument/asset pair.
PARAMS
instrument
btcusdtx_usdt_210430F70000000000
Example Request
Contract
curl --location --request GET '/public/contract?instrument=btcusdtx_usdt_210430F70000000000'
GET
Insider Profiles
/public/insider?username
Returns announcement with the server's time.
PARAMS
username
Example Request
Insider Profiles
curl --location --request GET '/public/insider?username'
GET
Insider Trades
/public/insider/trades?username
Returns announcement with the server's time.
PARAMS
username
Example Request
Insider Trades
curl --location --request GET '/public/insider/trades?username'
GET
Announcements
/public/announcements
Returns announcement with the server's time.
Example Request
Announcements
curl --location --request GET '/public/announcements'
GET
Order Types
/public/ordertypes
Returns enumeration of order types.
Example Request
Order Types
curl --location --request GET '/public/ordertypes'
GET
Supported Languages
/public/languages
Returns pairs of supported languages.
Example Request
Supported Languages
curl --location --request GET '/public/languages'
GET
Price Index
/public/index?instrument=btc_usdt_spot
Returns announcement with the server's time.
PARAMS
instrument
btc_usdt_spot
Example Request
Price Index
curl --location --request GET '/public/index?instrument=btc_usdt_spot'
GET
Search
/public/search?country=&instrument=
PARAMS
country
instrument
Example Request
Search
curl --location --request GET '/public/search?country=&instrument='
GET
ME Order Lag
/public/orderlag
Returns announcement with the server's time.
PARAMS
instrument
Example Request
ME Order Lag
curl --location --request GET '/public/orderlag'
GET
ME Throughput
/public/throughput
Returns announcement with the server's time.
Example Request
ME Throughput
curl --location --request GET '/public/throughput'
GET
Latency Data
/public/latency?instrument
Returns announcement with the server's time.
PARAMS
instrument
Example Request
Latency Data
curl --location --request GET '/public/latency?instrument'
GET
OTC
/public/otc?base_asset=btc"e_asset=usdt&spread=0.1
Returns announcement with the server's time.
PARAMS
base_asset
btc
quote_asset
usdt
spread
0.1
Example Request
OTC
curl --location --request GET '/public/otc?base_asset=btc"e_asset=usdt&spread=0.1'
GET
Get Convert Rate
/public/convert?from_coin&to_coin&size&value&convert_uuid
Returns announcement with the server's time.
PARAMS
from_coin
to_coin
size
value
convert_uuid
Example Request
Get Convert Rate
curl --location --request GET '/public/convert?from_coin&to_coin&size&value&convert_uuid'
POST
Subscribe Newsletter
/public/subscribe?email=testmail2@gmail.com
PARAMS
email
testmail2@gmail.com
Example Request
Subscribe Newsletter
curl --location --request POST '/public/subscribe?email=testmail2@gmail.com'
UDF
GET
Chart Config
/udf/config
Example Request
Chart Config
curl --location --request GET '/udf/config'
GET
Symbols
/udf/symbols?symbol=btc_usdt_spot
PARAMS
symbol
btc_usdt_spot
Example Request
Symbols
curl --location --request GET '/udf/symbols?symbol=btc_usdt_spot'
GET
Symbol Info
/udf/symbol_info?symbol=btc_usdt_spot
PARAMS
symbol
btc_usdt_spot
Example Request
Symbol Info
curl --location --request GET '/udf/symbol_info?symbol=btc_usdt_spot'
GET
Search
/udf/search?symbol=BTCUSDT&name=BTC/USDT&ticker=btc_usdt_spot¤cy_type=bitcoin¤cy_code=USD&exchange_traded=BITWYRE&exchange_listed=BITWYRE&limit=1
PARAMS
symbol
BTCUSDT
Optional
name
BTC/USDT
Optional
ticker
btc_usdt_spot
Optional
currency_type
bitcoin
Optional
currency_code
USD
Optional
exchange_traded
BITWYRE
Optional
exchange_listed
BITWYRE
Optional
limit
1
Optional
Example Request
Search
curl --location --request GET '/udf/search?symbol=BTCUSDT&name=BTC/USDT&ticker=btc_usdt_spot¤cy_type=bitcoin¤cy_code=USD&exchange_traded=BITWYRE&exchange_listed=BITWYRE&limit=1'
GET
History
/udf/history?symbol=btc_usdt_spot&from=1606083060&to=1626083060&resolution=1
PARAMS
symbol
btc_usdt_spot
from
1606083060
to
1626083060
resolution
1
Example Request
History
curl --location --request GET '/udf/history?symbol=btc_usdt_spot&from=1606083060&to=1626083060&resolution=1'
GET
Time
/udf/time
Example Request
Time
curl --location --request GET '/udf/time'