Q: What is an API and how is it used?
A: APIs allow you to connect OceanX with external programs such as Trading Bots and Portfolio Trackers, using an API Key and Secret Key for authentication.
------------------------------------------------------------------------------------------------------------------------
Q: What are the prerequisites for creating an API?
A: You must have: (1) A verified KYC, (2) 2FA / Google Authenticator enabled. If not yet set up, the system will prompt you to do so first.
------------------------------------------------------------------------------------------------------------------------
Q: How do I create an API Key?
A: (1) Profile Icon > Account, (2) API Management, (3) Create API, (4) Enter a Label, (5) Enter your GA Code, (6) Specify the permissions, (7) Press Save.
------------------------------------------------------------------------------------------------------------------------
Q: What permissions can be set for an API Key?
A: Read (read data), Trade (buy/sell), Withdraw (withdraw funds). It is recommended to grant only the necessary permissions — be especially careful with the Withdraw permission.
------------------------------------------------------------------------------------------------------------------------
Q: What is IP Whitelist and why should I set it up?
A: IP Whitelist restricts an API Key to be usable only from specified IP addresses. This increases security — even if the API Key is stolen, it cannot be used from any other IP.
------------------------------------------------------------------------------------------------------------------------
Q: I forgot my Secret Key. What should I do?
A: The Secret Key is displayed only once at the time of creation and cannot be viewed again. You must delete the old API Key and create a new one. It is strongly recommended to record it in a safe place immediately.
------------------------------------------------------------------------------------------------------------------------
Q: Is there a limit on the number of API Keys per account?
A: There is a limit on the number of API Keys per account. Check the allowed number on the API Management page or contact Customer Support.
------------------------------------------------------------------------------------------------------------------------
Q: My API Key was stolen. What should I do?
A: (1) Delete the API Key immediately in API Management, (2) Review transaction history for any anomalies, (3) Change your password and review your 2FA setup, (4) Contact Customer Support.
------------------------------------------------------------------------------------------------------------------------
Q: Can I delete or disable an API Key?
A: Yes. Select the API Key on the API Management page and press Delete or Disable. It is recommended to delete any API Keys that are no longer in use.
------------------------------------------------------------------------------------------------------------------------
Q: Can the API be used with a Trading Bot?
A: Yes. Grant the Trade permission to the API Key and it is recommended to use IP Whitelist. Do not grant the Withdraw permission unless absolutely necessary.
------------------------------------------------------------------------------------------------------------------------
Comments
0 comments
Please sign in to leave a comment.