Unlock a detailed view of the cost to borrow securities. This endpoint provides rich and actionable insights into the security lending fees associated with short selling and offers you a clear perspective on market behavior.
This API returns data for multiple stocks in an index for the specified date.
YYYY-MM-DD format).Try it out! You can test the API with the trial key TEST. Simply include it in your request headers; either here, or add the header "Ortex-Api-Key": "TEST" to your http request.
Trial key restrictions: A list of randomly selected rows will be returned
Get full access! Get a key at app.ortex.com/apis
# OpenAPI definition ```json { "openapi": "3.0.3", "info": { "title": "ORTEX APIs", "version": "1.0", "description": "A revolutionary global equity analytics platform which identifies and analyses relevant data for your stocks." }, "paths": { "/api/v1/index/short_ctb": { "get": { "operationId": "index_short_ctb_list", "description": "Unlock a detailed view of the cost to borrow securities. This endpoint provides rich and actionable insights into the security lending fees associated with short selling and offers you a clear perspective on market behavior.
\nThis API returns data for multiple stocks in an index for the specified date.
\nYYYY-MM-DD format).Try it out! You can test the API with the trial key TEST. Simply include it in your request headers; either here, or add the header \"Ortex-Api-Key\": \"TEST\" to your http request.
\nTrial key restrictions: A list of randomly selected rows will be returned
\nGet full access! Get a key at app.ortex.com/apis
\n", "summary": "Cost To Borrow", "parameters": [ { "in": "query", "name": "date", "schema": { "type": "string", "format": "date" }, "description": "Date for shorts data (defaults to last available date). Format: YYYY-MM-DD" }, { "in": "query", "name": "format", "schema": { "type": "string", "enum": [ "csv", "json" ], "default": "json" }, "description": "Format of the response. Can be \"json\" or \"csv\". Default is \"json\"." }, { "in": "query", "name": "index", "schema": { "type": "string", "enum": [ "Europe Top 600", "UK Top 100", "US-N 100", "US-S 500" ], "default": "US-S 500" }, "description": "An index name to list all the stocks from" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "portfolio_name", "schema": { "type": "string" }, "description": "Filter results to stocks held in a user portfolio, matched case-insensitively against the portfolio name. When provided, the index parameter is ignored." } ], "tags": [ "Short Interest" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedShortCTBIndexV1APIList" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/PaginatedShortCTBIndexV1APIList" } } }, "description": "" }, "400": { "description": "Invalid request parameters" }, "403": { "description": "Not authorized" }, "404": { "description": "Data not found" }, "429": { "description": "Rate limit exceeded" }, "500": { "description": "Internal server error" } } } } }, "components": { "schemas": { "PaginatedShortCTBIndexV1APIList": { "type": "object", "required": [ "length", "paginationLinks", "rows" ], "properties": { "paginationLinks": { "type": "object", "example": { "next": "http://api.example.org/accounts/?page=4", "previous": "http://api.example.org/accounts/?page=2" } }, "length": { "type": "integer", "example": 123 }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ShortCTBIndexV1API" } } } }, "ShortCTBIndexV1API": { "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "operatingMic": { "type": "string" }, "exchange": { "type": "string" }, "ticker": { "type": "string" }, "company": { "type": "string" }, "figi": { "type": "string" }, "shareClassFigi": { "type": "string" }, "costToBorrowAll": { "type": "number", "format": "double" }, "costToBorrowNew": { "type": "number", "format": "double" } }, "required": [ "company", "costToBorrowAll", "costToBorrowNew", "date", "exchange", "figi", "operatingMic", "shareClassFigi", "ticker" ] } }, "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "Ortex-Api-Key", "description": "Use test API key: `TEST` to get a limited result." } } }, "servers": [ { "url": "https://api.ortex.com/", "description": "Production" } ] } ```