# How to Create an Instrument entity

## Prerequisites

We assume you have all prerequisites you may need, including:

1. If needed: the VPN is configured to access the Finmars resources
2. If needed: access to the Virtual Machine to work with the sensitive information
3. Must have: registered in Finmars in the needed region environment (self-registered or registered by Finmars)
4. Must have: having permissions set to allow continue with the Action in the Guide

## Creation of Register Entity

1. <span style="color: rgb(170, 170, 170); background-color: rgb(34, 34, 34);">Open the</span> ****“Data”**** <span style="color: rgb(170, 170, 170); background-color: rgb(34, 34, 34);">section in the left-hand side menu. Select the</span> ****“Instruments”**** <span style="color: rgb(170, 170, 170); background-color: rgb(34, 34, 34); white-space: pre-wrap;">entity from the list under </span>****Data****<span style="color: rgb(170, 170, 170); background-color: rgb(34, 34, 34);">.</span>  
    [![Снимок экрана 2025-05-07 051134.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-07-051134.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-07-051134.png)
2. ****Click the “+ Add” button****<span style="color: rgb(170, 170, 170); background-color: rgb(34, 34, 34); white-space: pre-wrap;"> located in the top-left corner of the portfolio list view. </span>A dropdown menu will appear offering four methods to add a new instrument:
    1. ****Add Blank****<span style="white-space: pre-wrap;"> – manual entry with a fully blank template.</span>
    2. ****Add Typical****<span style="white-space: pre-wrap;"> – pre-filled template with commonly used default values.</span>
    3. ****Import from File****<span style="white-space: pre-wrap;"> – bulk import instruments using a file.</span>
    4. ****Get from Provider****<span style="white-space: pre-wrap;"> – retrieve instrument data from a market data provider.</span>

[![Снимок экрана 2025-05-07 051324.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-07-051324.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-07-051324.png)

##### Option 1: Add Blank

This opens a completely blank form where you can manually input all instrument details.

[![image.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/yC7image.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/yC7image.png)  
  
Fill out the following fields as needed:

1. ****Instrument****<span style="white-space: pre-wrap;"> – full name or unique identifier (required).</span>
2. ****Instrument type****<span style="white-space: pre-wrap;"> – defines the kind of instrument (e.g., Bond, Stock, FX Forward, etc.).</span>
3. ****Asset Type**** – specifies the financial asset classification (e.g., Equity, Fixed Income).
4. ****Country**** – country of issuance of the instrument.
5. ****Accrual Size Clarification****<span style="white-space: pre-wrap;"> – optional explanation or note for accrual calculation basis.</span>
6. ****Pricing currency****<span style="white-space: pre-wrap;"> – the currency in which the instrument's market price is quoted.</span>
7. ****Accrued currency****<span style="white-space: pre-wrap;"> – the currency in which interest or other accruals are calculated and reported.</span>
8. ****Price multiplier**** – multiplier applied to the quoted price to calculate notional or total value (e.g., 100 if price is per 100 units).
9. ****Accrued multiplier****<span style="white-space: pre-wrap;"> – multiplier used to adjust the accrual value, typically to scale interest or dividend values appropriately.</span>
10. ****Maturity date****<span style="white-space: pre-wrap;"> – the date when the instrument is due to mature and be settled (e.g., for bonds or term deposits).</span>
11. ****Maturity price****<span style="white-space: pre-wrap;"> – the expected price or value at maturity, often used in valuation or final settlement (if applicable).</span>
12. ****Notes**** – any relevant internal comments or additional metadata for this instrument.
13. ****Identifiers****<span style="white-space: pre-wrap;"> – optional key-value fields such as ISIN, CUSIP, internal codes, etc., used to uniquely identify the instrument.</span>

<span style="white-space: pre-wrap;">Click </span>****“Create and Exit”****<span style="white-space: pre-wrap;"> to save and return to the list, or</span> ****“Create”****<span style="white-space: pre-wrap;"> to save and continue editing.</span>  
[![Снимок экрана 2025-05-07 051440.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-07-051440.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/snimok-ekrana-2025-05-07-051440.png)

## Option 2: Add Typical

This will load a pre-filled template with default values for typical instruments, which can be modified as needed. Use this option to speed up creation when working with commonly used instruments.  
[![image.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/oTGimage.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/oTGimage.png)

<span style="white-space: pre-wrap;">Click </span>****“Create and Exit”****<span style="white-space: pre-wrap;"> to save and return to the list, or</span> ****“Create”****<span style="white-space: pre-wrap;"> to save and continue editing.</span>

## Option 3: Import from File

Use this option to import multiple instruments into the system from a prepared file (e.g., Excel or CSV).

1. ****Name****<span style="white-space: pre-wrap;"> – provide a name for the import process).</span>
2. ****Import Scheme**** – select the appropriate scheme that matches the structure of your file. This determines how the system interprets and maps the data.
3. ****Browse**** – click this button to choose a file from your computer. Supported formats depend on the selected import scheme (e.g., .xlsx, .csv).  
    [![image.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/Yrnimage.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/Yrnimage.png)

<span style="white-space: pre-wrap;">After selecting the file, click </span>****“Validate”****<span style="white-space: pre-wrap;"> to check the file for errors and confirm it matches the selected scheme. If the validation is successful, click </span>****“Import”****<span style="white-space: pre-wrap;"> to load the instruments into the database.</span>

## Option 4: Get from Provider

Automatically pull instrument data from a connected market data provider.

[![image.png](https://docs.finmars.com/uploads/images/gallery/2025-05/scaled-1680-/7gTimage.png)](https://docs.finmars.com/uploads/images/gallery/2025-05/7gTimage.png)

<span style="white-space: pre-wrap;">After selecting the desired instrument, click the </span>****“Add”****<span style="white-space: pre-wrap;"> button to load it into the system.</span>