Link a security to the partner's own security identifier. This will overwrite any existing link.

### Request Body

- `security_guid` (string, required): GUID of the security in TakeProfit system.
    
- `partner_security_id` (string, required): Partner's own identifier for the security.
    

### Response

- `status`: Operation status.
    

---

### Linked Security JSON Schema

``` json
{
    "type": "object",
    "properties": {
        "security_guid": { "type": "string" },
        "partner_security_id": { "type": "string" }
    },
    "required": ["security_guid", "partner_security_id"]
}

 ```

---

## Frequently Asked Questions

### Can I overwrite an existing link?

Yes, calling \`LinkSecurity\` with the same \`security_guid\` will overwrite the existing \`partner_security_id\`.

Link Security

TakeProfit

The TakeProfit Widget SDK is a tool designed to help developers create and integrate interactive, data-driven widgets directly into the TakeProfit platform. Widgets embedded with this SDK can communicate with the platform, exchange data, and offer seamless, customized experiences for users.

Introduction

Step-by-step guide to install the TakeProfit Widget SDK, covering prerequisites, installation commands, and initial setup. Follow this guide to ensure the SDK is correctly integrated into your project and ready for widget development on the TakeProfit platform.

SDK Installation

This guide provides a comprehensive, step-by-step process to create your first custom widget using the TakeProfit Widget SDK.

Creating Your First Widget

This guide provides a comprehensive, step-by-step process to create your first custom widget using **Angular** and the **TakeProfit Widget SDK** (version **0.2.3**). By following this guide, you'll set up an Angular project, integrate the SDK, configure necessary security headers, and implement basic functionalities to interact with the TakeProfit platform. This example serves as a foundation for building more complex and feature-rich widgets tailored to your specific needs.

Angular

This guide provides a comprehensive, step-by-step process to create your first custom widget using **Nuxt.js** and the **TakeProfit Widget SDK** (version **0.2.3**). By following this guide, you'll set up a Nuxt.js project, integrate the SDK, configure necessary security headers, and implement basic functionalities to interact with the TakeProfit platform. This example serves as a foundation for building more complex and feature-rich widgets tailored to your specific needs.

Nuxt.js

This guide provides a comprehensive, step-by-step process to create your first custom widget using **Vanilla JavaScript** and the **TakeProfit Widget SDK** (version **0.2.3**). By following this guide, you'll set up a simple project structure, integrate the SDK, configure necessary security headers, and implement basic functionalities to interact with the TakeProfit platform. This example serves as a foundation for building more complex and feature-rich widgets tailored to your specific needs.

Vanilla JS

This SDK reference provides comprehensive details about the methods, interfaces, and message types available in the TakeProfit Widget SDK. It is designed to help developers effectively integrate and utilize the SDK to build interactive widgets within the TakeProfit platform.

Widget SDK Reference

Overview of the TakeProfit Partner APIs and how they can be used to access financial data, security information, manage security links and more.

Authenticates a partner using their API key.

### Request Body

- **api_key** (`string`, required): Your unique API key provided by TakeProfit.
    

### Response

- **status**:
    
    - **code** (`integer`): Status code (`0` indicates success).
        
    - **message** (`string`): Status message.
        
    - **details** (`array`): Additional details.
        
- **access_token**:
    
    - **token** (`string`): JWT access token.
        
    - **valid_to_time** (`string`): Expiration time of the access token in ISO 8601 format.
        
- **refresh_token**:
    
    - **token** (`string`): JWT refresh token.
        
    - **valid_to_time** (`string`): Expiration time of the refresh token in ISO 8601 format.

Create Token

Generates a new access token using a valid refresh token.

### Request Body

- **refresh_token** (`string`, required): A valid refresh token obtained from the Login endpoint.
    

### Response

- **status**:
    
    - **code** (`integer`): Status code (`0` indicates success).
        
    - **message** (`string`): Status message.
        
    - **details** (`array`): Additional details.
        
- **access_token**:
    
    - **token** (`string`): New JWT access token.
        
    - **valid_to_time** (`string`): Expiration time of the new access token in ISO 8601 format.

Refresh Token

Remove the linkage between a security and the partner's identifier.

### Request Body

- `security_guid` (string, required): GUID of the security to unlink.
    

### Response

- `status`: Operation status.

Unlink Security

Retrieve a list of all securities linked by the partner.

### Response

- `status`: Operation status.
    
    - `code` (integer): Status code (`0` indicates success).
        
    - `message` (string): Status message.
        
    - `details` (array): Additional details.
        
- `linked_securities` (array): List of linked securities.
    
    - Each item contains:
        
        - `security_guid` (string): GUID of the security in TakeProfit system.
            
        - `partner_security_id` (string): Partner's own identifier for the security.
            

---

## JSON Schemas

#### Status

``` json
{
    "type": "object",
    "properties": {
        "code": { "type": "integer" },
        "message": { "type": "string" },
        "details": { "type": "array", "items": {} }
    },
    "required": ["code", "message"]
}

 ```

#### Linked Security

``` json
{
    "type": "object",
    "properties": {
        "security_guid": { "type": "string" },
        "partner_security_id": { "type": "string" }
    },
    "required": ["security_guid", "partner_security_id"]
}

 ```

### List Linked Securities

``` json
{
    "type": "object",
    "properties": {
        "status": { "$ref": "#/definitions/Status" },
        "linked_securities": {
            "type": "array",
            "items": { "$ref": "#/definitions/LinkedSecurity" }
        }
    },
    "required": ["status", "linked_securities"]
}

 ```

List Linked Securities

Retrieve the linkage information for a specific security.

### Request Body

- `security_guid` (string, required): GUID of the security in TakeProfit system.
    

### Response

- `status`: Operation status.
    
- `linked_security`: The linked security information.
    
    - `security_guid` (string): GUID of the security.
        
    - `partner_security_id` (string): Partner's identifier.

Get Linked Security

The `Security Info` method allows you to retrieve detailed information about multiple securities identified by ticker and exchange code or by GUID.

### Request Body

- `security_ids` (required): An array of security identifiers.
    
    Each element can contain one of the following options:
    
    - `ticker_code`:
        
        - `ticker` (string): The security's ticker symbol.
            
        - `exchange_code` (string): The exchange code.
            
    - `guid` (string): The security's Global Unique Identifier.
        

### Response

- `securities`: An array of objects containing information about each requested security.
    
    - `status`:
        
        - `code` (integer): Operation status code (`0` - success).
            
        - `message` (string): Status message.
            
        - `details` (array): Additional details.
            
    - `security_id`: The security identifier corresponding to the request.
        
    - `security_info`: Detailed information about the security.
        
        - `ticker` (string): The security's ticker symbol.
            
        - `names` (map): Names in different languages.
            
        - `exchange_code` (string): The exchange code.
            
        - `cfi` (string): ISO 10962 (CFI) code.
            
        - `isin` (string): International Securities Identification Number (ISIN).
            
        - `status` (integer): Security status (1 - active).
            
        - `price_precision` (integer): Price precision (number of decimal places).
            
        - `tick_size`: Price tick size.
            
            - `value` (string): The value.
                
            - `scale` (string): The scale (divisor).
                
        - `asset_base`: Base asset.
            
            - `id`:
                
                - `code` (string): Asset code.
                    
                - `asset_class_code` (string): Asset class code.
                    
            - `icon_url` (string): URL of the asset's icon.
                
            - `background_color` (string): Background color.
                
            - `company`: Company information.
                
                - `name` (string): Company name.
                    
                - `industries` (array): Industries.
                    
        - `asset_quote`: Quote asset.
            
            - `id`:
                
                - `code` (string): Asset code.
                    
                - `asset_class_code` (string): Asset class code.
                    
        - `classes`: Security classes.
            
        - `guid` (string): Global Unique Identifier.
            
        - `exchange_alias` (string): Exchange alias.
            
        - `price_precisions`: Array of price precision settings for different ranges.
            

---

## JSON Schemas

### Request Schema

``` json
{
  "type": "object",
  "properties": {
    "security_ids": {
      "type": "array",
      "items": {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "ticker_code": {
                "type": "object",
                "properties": {
                  "ticker": { "type": "string" },
                  "exchange_code": { "type": "string" }
                },
                "required": ["ticker", "exchange_code"]
              }
            },
            "required": ["ticker_code"]
          },
          {
            "type": "object",
            "properties": {
              "guid": { "type": "string" }
            },
            "required": ["guid"]
          }
        ]
      }
    }
  },
  "required": ["security_ids"]
}

 ```

### Response Schema

``` json
{
  "type": "object",
  "properties": {
    "securities": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "status": {
            "$ref": "#/definitions/Status"
          },
          "security_id": {
            "$ref": "#/definitions/SecurityId"
          },
          "security_info": {
            "$ref": "#/definitions/SecurityInfo"
          }
        }
      }
    }
  },
  "definitions": {
    "Status": {
      "type": "object",
      "properties": {
        "code": { "type": "integer" },
        "message": { "type": "string" },
        "details": { "type": "array", "items": {} }
      }
    },
    "SecurityId": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "ticker_code": {
              "type": "object",
              "properties": {
                "ticker": { "type": "string" },
                "exchange_code": { "type": "string" }
              },
              "required": ["ticker", "exchange_code"]
            }
          }
        },
        {
          "type": "object",
          "properties": {
            "guid": { "type": "string" }
          }
        }
      ]
    },
    "SecurityInfo": {
      "type": "object",
      "properties": {
        "ticker": { "type": "string" },
        "names": {
          "type": "object",
          "additionalProperties": { "type": "string" }
        },
        "exchange_code": { "type": "string" },
        "cfi": { "type": "string" },
        "isin": { "type": "string" },
        "status": { "type": "integer" },
        "price_precision": { "type": "integer" },
        "tick_size": { "$ref": "#/definitions/Decimal" },
        "asset_base": { "$ref": "#/definitions/Asset" },
        "asset_quote": { "$ref": "#/definitions/Asset" },
        "classes": {
          "type": "array",
          "items": { "$ref": "#/definitions/SecurityClass" }
        },
        "guid": { "type": "string" },
        "exchange_alias": { "type": "string" },
        "price_precisions": {
          "type": "array",
          "items": { "$ref": "#/definitions/PricePrecision" }
        }
      }
    },
    "Decimal": {
      "type": "object",
      "properties": {
        "value": { "type": "string" },
        "scale": { "type": "string" }
      }
    },
    "Asset": {
      "type": "object",
      "properties": {
        "id": { "$ref": "#/definitions/AssetId" },
        "icon_url": { "type": "string" },
        "background_color": { "type": "string" },
        "company": { "$ref": "#/definitions/Company" }
      }
    },
    "AssetId": {
      "type": "object",
      "properties": {
        "code": { "type": "string" },
        "asset_class_code": { "type": "string" }
      }
    },
    "Company": {
      "type": "object",
      "properties": {
        "name": { "type": "string" },
        "industries": {
          "type": "array",
          "items": { "$ref": "#/definitions/Industry" }
        }
      }
    },
    "Industry": {
      "type": "object",
      "properties": {
        "name": { "type": "string" },
        "industries": {
          "type": "array",
          "items": {}
        }
      }
    },
    "SecurityClass": {
      "type": "object",
      "properties": {
        "name": { "type": "string" },
        "parent_class": { "$ref": "#/definitions/SecurityClass" },
        "top_level_class": { "$ref": "#/definitions/SecurityClass" }
      }
    },
    "PricePrecision": {
      "type": "object",
      "properties": {
        "price_from": { "$ref": "#/definitions/Decimal" },
        "price_to": { "$ref": "#/definitions/Decimal" },
        "precision": { "type": "integer" }
      }
    }
  }
}

 ```

---

## Usage Recommendations

- **Authorization**: Always use a valid `access_token` in the `accesstoken` header.
    
- **Error Handling**: Check the `status` field in the response to determine the success of the operation.
    
- **Identifiers**: Use `guid` for unique identification of securities when possible.
    

---

## Frequently Asked Questions

### What should I do if I receive an "Invalid access token" error?

Ensure you are using a valid `access_token` obtained through the [Auth API](#). Tokens may expire, in which case you need to obtain a new one using the `refresh_token`.

### Can I request information about a single security?

Yes, you can specify a single identifier in the `security_ids` array.

### How can I get a list of available exchanges and their codes?

Refer to the relevant documentation or API that provides information about exchanges.

---

## Additional Resources

- [Auth API Documentation](#)
    
- [ISO 10962 (CFI)](https://en.wikipedia.org/wiki/ISO_10962)
    
- [ISO 6166 (ISIN)](https://en.wikipedia.org/wiki/International_Securities_Identification_Number)
    

---

Security Info

The `ListCandles` method retrieves historical candlestick data for a given security, time frame, and range. This documentation provides details on how to use the `ListCandles` endpoint, including request and response formats, and includes JSON schemas for the request and response.

### Request Body

- `security_id` (object, required): Identifier of the security.
    
    - One of:
        
        - `guid` (string): Global Unique Identifier of the security.
            
        - `ticker_code` (object):
            
            - `ticker` (string): Ticker symbol.
                
            - `exchange_code` (string): Exchange code.
                
- `time_frame` (object, required): Time frame for the candles.
    
    - `time_unit` (string, required): Unit of time. Possible values: `MINUTE`, `HOUR`, `DAY`, `WEEK`, `MONTH`, `QUARTER`, `YEAR`.
        
    - `count` (integer): Number of `time_unit`s per candle (e.g., 1 for daily candles).
        
- `range` (object, required): Range of the historical data.
    
    - One of:
        
        - `first_bound_time` (string): The starting time (ISO 8601 format).
            
        - `second_bound_time` (string): The ending time (ISO 8601 format).
            
        - `duration` (string): Duration of the range (e.g., `"PT5H"` for 5 hours).
            
        - `count` (integer): Number of candles to retrieve. Negative for past data relative to `first_bound_time`.
            

### Response

- `candles` (array): An array of candle objects.
    
    - Each candle object contains:
        
        - `time` (string): The start time of the candle in ISO 8601 format.
            
        - `open` (object): Open price.
            
            - `value` (string): Numeric value as a string.
                
            - `scale` (string): Scale factor (divisor).
                
        - `high` (object): High price.
            
        - `low` (object): Low price.
            
        - `close` (object): Close price.
            
        - `volume` (object): Volume.
            
        - `session_type` (integer): Session type (e.g., 0 for MAINSESSION).
            

---

## JSON Schemas

### Request Schema

``` json
{
  "type": "object",
  "properties": {
    "security_id": {
      "type": "object",
      "oneOf": [
        {
          "properties": {
            "guid": {
              "type": "string"
            }
          },
          "required": ["guid"]
        },
        {
          "properties": {
            "ticker_code": {
              "type": "object",
              "properties": {
                "ticker": {
                  "type": "string"
                },
                "exchange_code": {
                  "type": "string"
                }
              },
              "required": ["ticker", "exchange_code"]
            }
          },
          "required": ["ticker_code"]
        }
      ]
    },
    "time_frame": {
      "type": "object",
      "properties": {
        "time_unit": {
          "type": "string",
          "enum": ["MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR"]
        },
        "count": {
          "type": "integer",
          "minimum": 1
        }
      },
      "required": ["time_unit"]
    },
    "range": {
      "type": "object",
      "oneOf": [
        {
          "properties": {
            "first_bound_time": {
              "type": "string",
              "format": "date-time"
            },
            "second_bound_time": {
              "type": "string",
              "format": "date-time"
            }
          },
          "required": ["first_bound_time", "second_bound_time"]
        },
        {
          "properties": {
            "first_bound_time": {
              "type": "string",
              "format": "date-time"
            },
            "duration": {
              "type": "string"
            }
          },
          "required": ["first_bound_time", "duration"]
        },
        {
          "properties": {
            "first_bound_time": {
              "type": "string",
              "format": "date-time"
            },
            "count": {
              "type": "integer"
            }
          },
          "required": ["first_bound_time", "count"]
        }
      ]
    },
    "properties": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": ["OPEN", "HIGH", "LOW", "CLOSE", "VALUE", "VOLUME", "SESSION_TYPE"]
      }
    },
    "session_types": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": ["MAINSESSION", "PRE_MARKET", "POST_MARKET"]
      }
    }
  },
  "required": ["security_id", "time_frame", "range"]
}

 ```

### Response Schema

``` json
{
  "type": "object",
  "properties": {
    "candles": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "time": {
            "type": "string",
            "format": "date-time"
          },
          "open": {
            "$ref": "#/definitions/Decimal"
          },
          "high": {
            "$ref": "#/definitions/Decimal"
          },
          "low": {
            "$ref": "#/definitions/Decimal"
          },
          "close": {
            "$ref": "#/definitions/Decimal"
          },
          "volume": {
            "$ref": "#/definitions/Decimal"
          },
          "session_type": {
            "type": "integer",
            "enum": [0, 1, 2]
          }
        },
        "required": ["time"]
      }
    }
  },
  "definitions": {
    "Decimal": {
      "type": "object",
      "properties": {
        "value": {
          "type": "string"
        },
        "scale": {
          "type": "string"
        }
      },
      "required": ["value", "scale"]
    }
  }
}

 ```

---

## Usage Recommendations

- **Authorization**: Always use a valid `access_token` in the `accesstoken` header.
    
- **Error Handling**: Check the `status` field in the response to determine the success of the operation.
    
- **Time Zones**: All times are in UTC. Ensure your application handles time zones appropriately.
    
- **Data Interpretation**:
    
    - **Decimal Fields**: To calculate the real value of decimal fields, use `real_value = value / scale`. For example, if `value` is `"21210"` and `scale` is `"100"`, the real value is `21210 / 100 = 212.10`.
        

---

## Frequently Asked Questions

### How do I interpret the `Decimal` fields?

The `Decimal` fields use a `value` and `scale` to represent decimal numbers precisely. Compute the real value as `value / scale`.

### What is the `session_type` field?

The `session_type` indicates the trading session:

- `0`: MAINSESSION
    
- `1`: PRE_MARKET
    
- `2`: POST_MARKET
    

### Can I request candles for a custom time frame?

Yes, you can specify the `time_frame` with different `time_unit` and `count` values to create custom time frames, such as 5-minute or 15-minute candles.

---

## Additional Resources

- [Auth API Documentation](#)
    
- [ISO 8601 Date Format](https://en.wikipedia.org/wiki/ISO_8601)

Getting Started

Credentials

Link

Reference API

Marketdata API

Link Security

Request Body

Response

Linked Security JSON Schema

Frequently Asked Questions

Can I overwrite an existing link?

Headers

Body

Response