GetPrice
Retrieve real-time price data for financial instruments using symbol, ISIN, FIGI, or CUSIP with a lightweight API endpoint for quick market insights.
Instructions
This endpoint is a lightweight method that allows retrieving only the real-time price of the selected instrument.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| params | Yes |
Input Schema (JSON Schema)
{
"$defs": {
"GetPriceRequest": {
"description": "This endpoint is a lightweight method that allows retrieving only the real-time price of the selected instrument.",
"properties": {
"apikey": {
"default": "demo",
"description": "API key",
"examples": [
"demo"
],
"title": "Apikey",
"type": "string"
},
"country": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Country where instrument is traded",
"title": "Country"
},
"cusip": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The CUSIP of an instrument for which data is requested",
"examples": [
"594918104"
],
"title": "Cusip"
},
"delimiter": {
"default": ";",
"description": "Specify the delimiter used when downloading the CSV file",
"title": "Delimiter",
"type": "string"
},
"dp": {
"default": 5,
"description": "Specifies the number of decimal places for floating values.\nShould be in range [0,11] inclusive",
"title": "Dp",
"type": "integer"
},
"exchange": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Exchange where instrument is traded",
"title": "Exchange"
},
"figi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Filter by financial instrument global identifier (FIGI)",
"examples": [
"BBG000BHTMY7"
],
"title": "Figi"
},
"format": {
"default": "JSON",
"description": "Value can be JSON or CSV",
"title": "Format",
"type": "string"
},
"isin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Filter by international securities identification number (ISIN)",
"examples": [
"US0378331005"
],
"title": "Isin"
},
"mic_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Market Identifier Code (MIC) under ISO 10383 standard",
"title": "Mic Code"
},
"prepost": {
"default": false,
"description": "Parameter is optional. Only for Pro and above plans.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for all US equities.\nOpen, high, low, close values are supplied without volume.",
"title": "Prepost",
"type": "boolean"
},
"symbol": {
"description": "Symbol ticker of the instrument",
"examples": [
"AAPL"
],
"title": "Symbol",
"type": "string"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The asset class to which the instrument belongs",
"examples": [
"ETF"
],
"title": "Type"
}
},
"required": [
"symbol"
],
"title": "GetPriceRequest",
"type": "object"
}
},
"properties": {
"params": {
"$ref": "#/$defs/GetPriceRequest"
}
},
"required": [
"params"
],
"title": "GetPriceArguments",
"type": "object"
}