Security Info

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

{
  "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

{
  "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)

• ISO 6166 (ISIN)