> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://okx-demo.ferndocs.com/api/api-reference/account/get-instruments/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://okx-demo.ferndocs.com/_mcp/server. # Get account instruments GET https://www.okx.com/api/v5/account/instruments Retrieve tradable instruments available to the current account. Reflects the account's trading permissions and settings. Reference: https://okx-demo.ferndocs.com/api/api-reference/account/get-instruments ## Authentication - `OK-ACCESS-KEY` header (required) — Your API key. - `OK-ACCESS-SIGN` header (required) — Base64-encoded HMAC-SHA256 signature of the prehash string. - `OK-ACCESS-TIMESTAMP` header (required) — ISO 8601 UTC timestamp, e.g. 2020-12-08T09:08:57.715Z. - `OK-ACCESS-PASSPHRASE` header (required) — The passphrase you set when creating the API key. ## Request ### Query parameters - `instType` (enum, required) — Instrument type. - Allowed values: `SPOT`, `MARGIN`, `SWAP`, `FUTURES`, `OPTION`, `EVENTS` - `uly` (string, optional) — Underlying, only applicable to FUTURES/SWAP/OPTION. - `instFamily` (string, optional) — Instrument family, only applicable to FUTURES/SWAP/OPTION. - `instId` (string, optional) — Instrument ID. ## Response ### 200 Successful response - `code` (string, optional) — Result code. `0` means success; any other value is an error code. - `msg` (string, optional) — Error message. Empty on success. - `data` (list of ApiV5AccountInstrumentsGetResponsesContentApplicationJsonSchemaDataItems, optional) ## Types ### ApiV5AccountInstrumentsGetResponsesContentApplicationJsonSchemaDataItems - `instType` (string, optional) — Instrument type. - `instId` (string, optional) — Instrument ID. - `instFamily` (string, optional) — Instrument family. - `uly` (string, optional) — Underlying, only applicable to FUTURES/SWAP/OPTION. - `baseCcy` (string, optional) — Base currency, e.g. BTC in BTC-USDT. Only applicable to SPOT/MARGIN. - `quoteCcy` (string, optional) — Quote currency, e.g. USDT in BTC-USDT. Only applicable to SPOT/MARGIN. - `settleCcy` (string, optional) — Settlement and margin currency, only applicable to FUTURES/SWAP/OPTION. - `ctVal` (string, optional) — Contract value. - `ctMult` (string, optional) — Contract multiplier. - `ctValCcy` (string, optional) — Contract value currency. - `optType` (string, optional) — Option type, C for call, P for put. - `stk` (string, optional) — Strike price, only applicable to OPTION. - `listTime` (string, optional) — Listing time, Unix timestamp in milliseconds. - `expTime` (string, optional) — Expiry time, Unix timestamp in milliseconds. - `lever` (string, optional) — Maximum leverage. - `tickSz` (string, optional) — Tick size, e.g. 0.0001. - `lotSz` (string, optional) — Lot size. - `minSz` (string, optional) — Minimum order size. - `ctType` (string, optional) — Contract type, only applicable to FUTURES/SWAP. - `state` (string, optional) — Instrument status: live, suspend, preopen, test. ## Examples **Response** ```json { "code": "0", "msg": "", "data": [ { "instType": "SPOT", "instId": "BTC-EUR", "instFamily": "", "uly": "", "baseCcy": "BTC", "quoteCcy": "EUR", "settleCcy": "", "ctVal": "", "ctMult": "", "ctValCcy": "", "optType": "", "stk": "", "listTime": "1704876947000", "expTime": "", "lever": "", "tickSz": "1", "lotSz": "0.00000001", "minSz": "0.00001", "ctType": "", "state": "live", "auctionEndTime": "", "contTdSwTime": "1704876947000", "elp": "0", "floatPxLmtPct": "0.03", "futureSettlement": false, "groupId": "4", "initPxLmtPct": "0.05", "instCategory": "1", "instIdCode": 1000000000, "maxIcebergSz": "9999999999.0000000000000000", "maxLmtAmt": "1000000", "maxLmtSz": "9999999999", "maxMktAmt": "1000000", "maxMktSz": "1000000", "maxPlatOICoinLmt": "", "maxPlatOILmt": "1000000000", "maxPxLmtPct": "0.15", "maxStopSz": "1000000", "maxTriggerSz": "9999999999.0000000000000000", "maxTwapSz": "9999999999.0000000000000000", "openType": "call_auction", "posLmtAmt": "2500000", "posLmtPct": "30", "preMktSwTime": "", "rpi": "0", "ruleType": "normal", "tradeQuoteCcyList": [ "EUR" ], "upcChg": [ { "effTime": "1704876947000", "newValue": "0.0001", "param": "tickSz" } ] } ] } ``` **SDK Code** ```python account_getInstruments_example import requests url = "https://www.okx.com/api/v5/account/instruments" querystring = {"instType":"SPOT"} headers = {"OK-ACCESS-KEY": ""} response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript account_getInstruments_example const url = 'https://www.okx.com/api/v5/account/instruments?instType=SPOT'; const options = {method: 'GET', headers: {'OK-ACCESS-KEY': ''}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go account_getInstruments_example package main import ( "fmt" "net/http" "io" ) func main() { url := "https://www.okx.com/api/v5/account/instruments?instType=SPOT" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("OK-ACCESS-KEY", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby account_getInstruments_example require 'uri' require 'net/http' url = URI("https://www.okx.com/api/v5/account/instruments?instType=SPOT") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["OK-ACCESS-KEY"] = '' response = http.request(request) puts response.read_body ``` ```java account_getInstruments_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://www.okx.com/api/v5/account/instruments?instType=SPOT") .header("OK-ACCESS-KEY", "") .asString(); ``` ```php account_getInstruments_example request('GET', 'https://www.okx.com/api/v5/account/instruments?instType=SPOT', [ 'headers' => [ 'OK-ACCESS-KEY' => '', ], ]); echo $response->getBody(); ``` ```csharp account_getInstruments_example using RestSharp; var client = new RestClient("https://www.okx.com/api/v5/account/instruments?instType=SPOT"); var request = new RestRequest(Method.GET); request.AddHeader("OK-ACCESS-KEY", ""); IRestResponse response = client.Execute(request); ``` ```swift account_getInstruments_example import Foundation let headers = ["OK-ACCESS-KEY": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://www.okx.com/api/v5/account/instruments?instType=SPOT")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```