Skip to main content

/apiKey field definitions

  • Updated

Below are the field definitions returned from /apiKey endpoint:

[
{
"id": "string", // ID of the API key.
"secret": "string", // ID of the secret API key.
"name": "string", // Name of the API key.
"nonce": 0, // This scheme is no longer supported. The nonce scheme will still be valid for generating signatures used to authenticate with the API.
"cidr": "string", // IP Restriction feature - To restrict to a single address. Leave blank or set to 0.0.0.0 to allow all IPs. Only one block may be set.
"cidrs":[], // IP Restriction feature - To restrict multiple addresses.
"targetAccountId": 0, // The user ID the API key acts on behalf of
"permissions": [], // Key permissions. All keys can read margin and position data. Additional permissions must be added. Available: order, orderCancel, withdraw.
"enabled": false, // Set to true to enable this key.
"userId": 0, // Unique user ID.
"created": "2020-09-14T02:04:59.423Z" // Date and time that the key was created.
}
]

Related articles

This website is operated by HDR Global Trading Limited, a company incorporated under the International Business Companies Act of 1994 of the Republic of Seychelles with a company number of 148707 and registered address at Global Gateway 8, Rue de la Perle, Providence Mahé, Seychelles (“HDR”). HDR wholly owns BitMEX, a Bitcoin-based trading platform.


Access to trading or holding positions on BitMEX is prohibited for any person or entity that is located, incorporated or otherwise established in, or a citizen or a resident of: (i) the United States of America, Québec (Canada), the Hong Kong Special Administrative Region of the People’s Republic of China, the Republic of Seychelles, Bermuda, Cuba, Crimea and Sevastopol, Iran, Syria, North Korea or Sudan; (ii) any state, country or other jurisdiction that is embargoed by the United States of America; or (iii) any other jurisdiction where the services offered by BitMEX are restricted (collectively “Restricted Jurisdictions”). If it is determined that any BitMEX user has given false representations as to their location, incorporation, establishment, citizenship or residence, or HDR detects a user is from a Restricted Jurisdiction as described above, HDR reserves the right to immediately close their accounts and liquidate any open positions. HDR may, in its sole discretion, implement controls to restrict access to the BitMEX trading platform in any of the Restricted Jurisdictions.