> For the complete documentation index, see [llms.txt](https://www.notbank.com/learn/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.notbank.com/learn/api-reference/websocket-api/instrument-pair.md).
# Instrument (Pair)
### GetInstrument
**Permissions:** Public\
**Call Type:** Synchronous
Gets the details of a specific instrument (pair) from the OMS of the trading venue. An instrument is something that can be traded in the exchange.
#### Request
{% tabs %}
{% tab title="Node" %}
```javascript
import Notbank from 'notbank'
// websocket connection code ...
await client.getInstrumentService().getInstrument({
InstrumentId: 1
});
// parameters
{
InstrumentId: number;
}
```
{% endtab %}
{% tab title="Java" %}
```java
import exchange.notbank.instrument.paramBuilders.GetInstrumentParamBuilder;
var response = client.getInstrumentService().getInstrument(new GetInstrumentParamBuilder(1)).get();
```
{% endtab %}
{% tab title="Python" %}
```python
from notbank_python_sdk.requests_models import GetInstrumentRequest
response = client.get_instrument(GetInstrumentRequest(
instrument_id=1,
))
```
{% endtab %}
{% tab title="Json" %}
```json
{
"m": 0,
"i": 0,
"n": "GetInstrument",
"o": "{
\"OMSId\": 1,
\"InstrumentId\": 1
}"
}
```
{% endtab %}
{% endtabs %}
| Key | Value |
| ------------ | ---------------------------------------------------- |
| OMSId | **integer**. The ID of the OMS. **required**. |
| InstrumentId | **integer**. The ID of the instrument. **required**. |
#### Response
```json
{
"m": 1,
"i": 0,
"n": "GetInstrument",
"o": "{
\"OMSId\": 1,
\"InstrumentId\": 1,
\"Symbol\": \"BTCUSD\",
\"Product1\": 2,
\"Product1Symbol\": \"BTC\",
\"Product2\": 1,
\"Product2Symbol\": \"USD\",
\"InstrumentType\": \"Standard\",
\"VenueInstrumentId\": 1,
\"VenueId\": 1,
\"SortIndex\": 0,
\"SessionStatus\": \"Running\",
\"PreviousSessionStatus\": \"Unknown\",
\"SessionStatusDateTime\": \"2023-03-17T03:51:12.373Z\",
\"SelfTradePrevention\": false,
\"QuantityIncrement\": 0.00000001,
\"PriceIncrement\": 0.001,
\"MinimumQuantity\": 0.0001,
\"MinimumPrice\": 0.01,
\"VenueSymbol\": \"BTCUSD\",
\"IsDisable\": false,
\"MasterDataId\": 0,
\"PriceCollarThreshold\": 0.0,
\"PriceCollarPercent\": 0.0,
\"PriceCollarEnabled\": false,
\"PriceFloorLimit\": 0.0,
\"PriceFloorLimitEnabled\": false,
\"PriceCeilingLimit\": 0.0,
\"PriceCeilingLimitEnabled\": false,
\"CreateWithMarketRunning\": true,
\"AllowOnlyMarketMakerCounterParty\": false,
\"PriceCollarIndexDifference\": 10.0,
\"PriceCollarConvertToOtcEnabled\": false,
\"PriceCollarConvertToOtcClientUserId\": 0,
\"PriceCollarConvertToOtcAccountId\": 0,
\"PriceCollarConvertToOtcThreshold\": 0.0,
\"OtcConvertSizeThreshold\": 0.0,
\"OtcConvertSizeEnabled\": false,
\"OtcTradesPublic\": true,
\"PriceTier\": 1
}"
}
```
| Key | Value |
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| OMSId | **integer**. The ID of the OMS on which the instrument is traded. |
| InstrumentId | **integer**. The ID of the instrument. |
| Symbol | **string**. Trading symbol of the instrument, for example BTCUSD. |
| Product1 | **integer**. The ID of the first product comprising the instrument or the ID of the base product/currency of the instrument. |
| Product1Symbol | **string**. The symbol of the first product comprising the instrument or the symbol of the base product/currency of the instrument. |
| Product2 | **integer**. The ID of the second product comprising the instrument or the ID of the quote product/currency of the instrument. |
| Product2Symbol | **string**. The symbol of the second product comprising the instrument or the symbol of the quote product/currency of the instrument. |
| InstrumentType | string. A number representing the type of the instrument. All instrument types currently are standard, an exchange of one product for another (or unknown, an error condition), but this may expand to new types in the future.
- 0 Unknown (an error condition)
- 1 Standard
|
| VenueInstrumentId | **integer**. A venue instrument is created at the exchange level as an instrument "template" for adding new instruments to the exchange. This is the ID of the venue instrument behind the instrument being requested. |
| VenueId | **integer**. The ID of the trading venue on which the instrument trades. |
| SortIndex | **integer**. The numerical position in which to sort the returned list of instruments on a visual display. Since this call returns information about a single instrument, *SortIndex* should return 0. |
| SessionStatus | string. The current session status of the instrument. One of:
- 0 Unknown
- 1 Running
- 2 Paused
- 3 Stopped
- 4 Starting
- 5 RunningPostOnly
|
| PreviousSessionStatus | string. The previous session status of the instrument. One of:
- 0 Unknown
- 1 Running
- 2 Paused
- 3 Stopped
- 4 Starting
- 5 RunningPostOnly
|
| SessionStatusDateTime | **string**. The time and date at which the session status was reported, in Microsoft Ticks format. |
| SelfTradePrevention | **boolean**. An account that is trading with itself still incurs fees. If this instrument prevents an account from trading the instrument with itself, the value returns *true*. Default is *false*. |
| QuantityIncrement | **decimal**. The smallest tradeable increment of the instrument. For example, for BTCUSD, the quantity increment might be 0.0005, but for ETHUSD, the quantity increment might be 50. |
| PriceIncrement | **decimal**. The smallest amount by which the instrument can rise or fall in the market. |
| MinimumQuantity | **decimal**. The smallest quantity at which the instrument can be traded. |
| MinimumPrice | **decimal**. The lowest price that the instrument can have. |
| VenueSymbol | **string**. The symbol of the instrument in the trading venue or exchange. |
| IsDisable | **boolean**. Identifies if the instrument is available to be traded or not, if true, instrument cannot be traded, else it can be traded but would still depend on the **SessionStatus**. |
| PriceFloorLimit | **decimal**. The lowest price that the instrument can be traded in a specific session; for instance, daily price floor limit of an instrument can change, it really depends on regulator requirements most of the time. |
| PriceFloorLimitEnabled | **boolean**. If enabled price floor limit will apply. |
| PriceCeilingLimit | **decimal**. The highest price that the instrument can be traded in a specific session; for instance, daily price ceiling limit of an instrument can change, it really depends on regulator requirements most of the time. |
| PriceCeilingLimitEnabled | **boolean**. If enabled price ceiling limit will apply. |
| PriceTier | **integer**. The price tier the instrument. |
### GetInstruments
**Permissions:** Public\
**Call Type:** Synchronous
Gets a list of instruments available on the exchange. An instrument is something that can be traded in the exchange.
#### Request
{% tabs %}
{% tab title="Node" %}
```javascript
import Notbank from 'notbank'
// websocket connection code ...
//Get all instruments including the disabled ones
await client.getInstrumentService().getInstruments({
InstrumentState: InstrumentStateArgument.BOTH
});
//Get all disabled/inactive instruments only
await client.getInstrumentService().getInstruments({
InstrumentState: InstrumentStateArgument.INACTIVE
});
// parameters
{
InstrumentState?: InstrumentStateArgument;
}
```
{% endtab %}
{% tab title="Java" %}
```java
import exchange.notbank.instrument.constants.InstrumentState;
import exchange.notbank.instrument.paramBuilders.GetInstrumentsParamBuilder;
var response = client.getInstrumentService().getInstruments(new GetInstrumentsParamBuilder().instrumentState(InstrumentState.BOTH));
```
{% endtab %}
{% tab title="Python" %}
```python
from notbank_python_sdk.constants import InstrumentState
from notbank_python_sdk.requests_models import GetInstrumentsRequest
response = client.get_instruments(
GetInstrumentsRequest(instrument_state=InstrumentState.BOTH))
```
{% endtab %}
{% tab title="Json" %}
```json
//Get all enabled instruments only
{
"m": 0,
"i": 0,
"n": "GetInstruments",
"o": "{
\"OMSId\": 1
}"
}
//Get all instruments including the disabled ones
{
"m": 0,
"i": 0,
"n": "GetInstruments",
"o": "{
\"OMSId\": 1
\"InstrumentState\": \"both\"
}"
}
//Get all disabled/inactive instruments only
{
"m": 0,
"i": 0,
"n": "GetInstruments",
"o": "{
\"OMSId\": 1
\"InstrumentState\": \"inactive\"
}"
}
```
{% endtab %}
{% endtabs %}
| Key | Value |
| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| OMSId | **integer**. The ID of the OMS on which the instruments are available. **required**. |
| InstrumentState | **string**. Filters the results, you can include disabled instruments in the results, or you can just get disabled instruments if you want. One of: **Both**, **Inactive**. If set to **Both**, response will include all the instruments even the disabled instruments, if set to **Inactive**, response will only include all the **disabled** instruments, if not set, response will only return **enabled or active** instruments. **optional**. |
#### Response
```json
{
"m": 1,
"i": 0,
"n": "GetInstruments",
"o": "[
{
\"OMSId\": 1,
\"InstrumentId\": 2,
\"Symbol\": \"ETHUSD\",
\"Product1\": 4,
\"Product1Symbol\": \"ETH\",
\"Product2\": 1,
\"Product2Symbol\": \"USD\",
\"InstrumentType\": \"Standard\",
\"VenueInstrumentId\": 2,
\"VenueId\": 1,
\"SortIndex\": 0,
\"SessionStatus\": \"Running\",
\"PreviousSessionStatus\": \"Stopped\",
\"SessionStatusDateTime\": \"2023-01-23T04:49:21.699Z\",
\"SelfTradePrevention\": true,
\"QuantityIncrement\": 0.0001,
\"PriceIncrement\": 0.00000001,
\"MinimumQuantity\": 0.0001,
\"MinimumPrice\": 0.00000001,
\"VenueSymbol\": \"ETHUSD\",
\"IsDisable\": false,
\"MasterDataId\": 0,
\"PriceCollarThreshold\": 0.0,
\"PriceCollarPercent\": 0.0,
\"PriceCollarEnabled\": false,
\"PriceFloorLimit\": 0.0,
\"PriceFloorLimitEnabled\": false,
\"PriceCeilingLimit\": 0.0,
\"PriceCeilingLimitEnabled\": false,
\"CreateWithMarketRunning\": true,
\"AllowOnlyMarketMakerCounterParty\": false,
\"PriceCollarIndexDifference\": 10.0,
\"PriceCollarConvertToOtcEnabled\": false,
\"PriceCollarConvertToOtcClientUserId\": 0,
\"PriceCollarConvertToOtcAccountId\": 0,
\"PriceCollarConvertToOtcThreshold\": 0.0,
\"OtcConvertSizeThreshold\": 0.0,
\"OtcConvertSizeEnabled\": false,
\"OtcTradesPublic\": true,
\"PriceTier\": 0
},
{
\"OMSId\": 1,
\"InstrumentId\": 3,
\"Symbol\": \"TBTCUSD\",
\"Product1\": 3,
\"Product1Symbol\": \"TBTC\",
\"Product2\": 1,
\"Product2Symbol\": \"USD\",
\"InstrumentType\": \"Standard\",
\"VenueInstrumentId\": 3,
\"VenueId\": 1,
\"SortIndex\": 0,
\"SessionStatus\": \"Stopped\",
\"PreviousSessionStatus\": \"Paused\",
\"SessionStatusDateTime\": \"2022-10-25T17:56:32.218Z\",
\"SelfTradePrevention\": true,
\"QuantityIncrement\": 0.001,
\"PriceIncrement\": 0.001,
\"MinimumQuantity\": 0.001,
\"MinimumPrice\": 0.00000001,
\"VenueSymbol\": \"TBTCUSD\",
\"IsDisable\": false,
\"MasterDataId\": 0,
\"PriceCollarThreshold\": 0.0,
\"PriceCollarPercent\": 0.0,
\"PriceCollarEnabled\": false,
\"PriceFloorLimit\": 0.0,
\"PriceFloorLimitEnabled\": false,
\"PriceCeilingLimit\": 0.0,
\"PriceCeilingLimitEnabled\": false,
\"CreateWithMarketRunning\": true,
\"AllowOnlyMarketMakerCounterParty\": false,
\"PriceCollarIndexDifference\": 0.0,
\"PriceCollarConvertToOtcEnabled\": false,
\"PriceCollarConvertToOtcClientUserId\": 0,
\"PriceCollarConvertToOtcAccountId\": 0,
\"PriceCollarConvertToOtcThreshold\": 0.0,
\"OtcConvertSizeThreshold\": 0.0,
\"OtcConvertSizeEnabled\": false,
\"OtcTradesPublic\": true,
\"PriceTier\": 0
}
]"
}
```
The response for **GetInstruments** is an array of objects, each object represents an instrument.
| Key | Value |
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| OMSId | **integer**. The ID of the OMS on which the instrument is traded. |
| InstrumentId | **integer**. The ID of the instrument. |
| Symbol | **string**. Trading symbol of the instrument, for example BTCUSD. |
| Product1 | **integer**. The ID of the first product comprising the instrument or the ID of the base product/currency of the instrument. |
| Product1Symbol | **string**. The symbol of the first product comprising the instrument or the symbol of the base product/currency of the instrument. |
| Product2 | **integer**. The ID of the second product comprising the instrument or the ID of the quote product/currency of the instrument. |
| Product2Symbol | **string**. The symbol of the second product comprising the instrument or the symbol of the quote product/currency of the instrument. |
| InstrumentType | string. A number representing the type of the instrument. All instrument types currently are standard, an exchange of one product for another (or unknown, an error condition), but this may expand to new types in the future.
- 0 Unknown (an error condition)
- 1 Standard
|
| VenueInstrumentId | **integer**. A venue instrument is created at the exchange level as an instrument "template" for adding new instruments to the exchange. This is the ID of the venue instrument behind the instrument being requested. |
| VenueId | **integer**. The ID of the trading venue on which the instrument trades. |
| SortIndex | **integer**. The numerical position in which to sort the returned list of instruments on a visual display. Since this call returns information about a single instrument, *SortIndex* should return 0. |
| SessionStatus | string. The current session status of the instrument. One of:
- 0 Unknown
- 1 Running
- 2 Paused
- 3 Stopped
- 4 Starting
- 5 RunningPostOnly
|
| PreviousSessionStatus | string. The previous session status of the instrument. One of:
- 0 Unknown
- 1 Running
- 2 Paused
- 3 Stopped
- 4 Starting
- 5 RunningPostOnly
|
| SessionStatusDateTime | **string**. The time and date at which the session status was reported, in Microsoft Ticks format. |
| SelfTradePrevention | **boolean**. An account that is trading with itself still incurs fees. If this instrument prevents an account from trading the instrument with itself, the value returns *true*. Default is *false*. |
| QuantityIncrement | **decimal**. The smallest tradeable increment of the instrument. For example, for BTCUSD, the quantity increment might be 0.0005, but for ETHUSD, the quantity increment might be 50. |
| PriceIncrement | **decimal**. The smallest amount by which the instrument can rise or fall in the market. |
| MinimumQuantity | **decimal**. The smallest quantity at which the instrument can be traded. |
| MinimumPrice | **decimal**. The lowest price that the instrument can have. |
| VenueSymbol | **string**. The symbol of the instrument in the trading venue or exchange. |
| IsDisable | **boolean**. Identifies if the instrument is available to be traded or not, if true, instrument cannot be traded, else it can be traded but would still depend on the **SessionStatus**. |
| PriceFloorLimit | **decimal**. The lowest price that the instrument can be traded in a specific session; for instance, daily price floor limit of an instrument can change. |
| PriceFloorLimitEnabled | **boolean**. If enabled price floor limit will apply. |
| PriceCeilingLimit | **decimal**. The highest price that the instrument can be traded in a specific session; for instance, daily price ceiling limit of an instrument can change. |
| PriceCeilingLimitEnabled | **boolean**. If enabled price ceiling limit will apply. |
| PriceTier | **integer**. The price tier the instrument. |
### GetInstrumentVerificationLevelConfig
**Permissions:** NotbankTrading, NotbankDeposit, NotbankWithdraw\
**Call Type:** Synchronous
Gets an Instrument Verification Level Configurations for the requested account.
In NotBank, a verification level determines the limits of an account in terms of deposits, withdrawals, transfers and trading. The verification level config response of this method only applies to instruments.
Each instrument will have separate and possibly unique limits, different than other instruments.
A limit value of -1 means infinite or no limit.
#### Request
{% tabs %}
{% tab title="Node" %}
```javascript
import Notbank from 'notbank'
// websocket connection code ...
await client.getInstrumentService().getInstrumentVerificationLevelConfigs({
AccountId: 7
});
// parameters
{
AccountId: number;
}
```
{% endtab %}
{% tab title="Java" %}
```java
import exchange.notbank.instrument.paramBuilders.GetInstrumentVerificationLevelConfigParamBuilder;
var response = client.getInstrumentService().getInstrumentVerificationLevelConfig(
new GetInstrumentVerificationLevelConfigParamBuilder(7)).get();
```
{% endtab %}
{% tab title="Python" %}
```python
from notbank_python_sdk.requests_models import VerificationLevelConfigRequest
response = client.get_instrument_verification_level_config(
VerificationLevelConfigRequest(account_id=7))
```
{% endtab %}
{% tab title="Json" %}
```json
{
"m": 0,
"i": 0,
"n": "GetInstrumentVerificationLevelConfig",
"o": "{
\"OMSId\": 1,
\"AccoundId\": 7
}"
}
```
{% endtab %}
{% endtabs %}
| Key | Value |
| --------- | -------------------------------------------------------------------------------------------------------------------- |
| OMSId | **integer**. The ID of the OMS on which the account resides. **required**. |
| AccountId | **integer**. The ID of the account for which you wish to get instrument verification level config for. **required**. |
#### Response
```json
{
"m": 1,
"i": 0,
"n": "GetInstrumentVerificationLevelConfig",
"o": "{
\"Level\": 111,
\"LevelName\": null,
\"OMSId\": 1,
\"Instruments\": [
{
\"VerificationLevel\": 111,
\"VerificationLevelName\": null,
\"OMSId\": 1,
\"InstrumentId\": 1,
\"InstrumentName\": \"BTCUSD\",
\"DailyBuyLimit\": 0.0,
\"DailySellLimit\": 0.0,
\"MonthlyBuyLimit\": 0.0,
\"MonthlySellLimit\": 0.0,
\"NotionalProductId\": 1,
\"DailyNotionalLimit\": -1.0,
\"MonthlyNotionalLimit\": -1.0,
\"YearlyNotionalLimit\": -1.0
},
{
\"VerificationLevel\": 111,
\"VerificationLevelName\": null,
\"OMSId\": 1,
\"InstrumentId\": 2,
\"InstrumentName\": \"ETHUSD\",
\"DailyBuyLimit\": 0.0,
\"DailySellLimit\": 0.0,
\"MonthlyBuyLimit\": 0.0,
\"MonthlySellLimit\": 0.0,
\"NotionalProductId\": 1,
\"DailyNotionalLimit\": -1.0,
\"MonthlyNotionalLimit\": -1.0,
\"YearlyNotionalLimit\": -1.0
}
]
}"
}
```
| Key | Value |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| Level | **integer**. The verification level the account specified is currently on. |
| LevelName | **string**. The of the verification level the account specified is currently on. |
| OMSId | **integer**. The ID of the OMS on which the account resides. |
| Instruments | **array**. An array of objects, each object will contain the limits of a specific instrument, as described bellow in InstrumentLimits. |
**InstrumentLimits**
| Key | Value |
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| InstrumentId | **integer**. The ID of the of the instrument for which the limits apply to. |
| InstrumentName | **string**. The name of the instrument for which the limits apply to. |
| DailyBuyLimit | **decimal**. The maximum amount of the specific instrument that the specified account can buy within a day. |
| DailySellLimit | **decimal**. The maximum amount of the specific instrument that the specified account can sell within a day. |
| MonthlyBuyLimit | **decimal**. The maximum amount of the specific instrument that the specified account can buy within a month. |
| MonthlySellLimit | **decimal**. The maximum amount of the specific instrument that the specified account can sell within a month. |
| NotionalProductId | **integer**. The Id of the notional product for the instrument. |
| DailyNotionalLimit | **decimal**. The maximum notional amount of the specific instrument that the specified account can buy and sell within a day. Buy and Sell trade amount are combined. |
| MonthlyNotionalLimit | **decimal**. The maximum notional amount of the specific instrument that the specified account can buy and sell within a month. Buy and Sell trade amount are combined. |
| YearlyNotionalLimit | **decimal**. The maximum notional amount of the specific instrument that the specified account can buy and sell within a year. Buy and Sell trade amount are combined. |
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://www.notbank.com/learn/api-reference/websocket-api/instrument-pair.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.