Get an instrument

GET

https://api.t-dx.com/api/rest/v1/instruments/:id

GET

/api/rest/v1/instruments/:id

curl https://api.t-dx.com/api/rest/v1/instruments/id

{
  "result": {
    "id": "string",
    "issuerId": "string",
    "type": "TYPE_STOCK",
    "swissStampTaxType": "SWISS_STAMP_TAX_TYPE_SWISS_SECURITIES",
    "fullName": "string",
    "shortName": "string",
    "symbol": "string",
    "isin": "string",
    "securityNumber": "string",
    "finmaTokensClassifications": [
      "FINMA_TOKEN_CLASSIFICATION_NONE"
    ],
    "snbStatisticReportCode": "SNB_STAT_REPORT_CODE_HOUSEHOLD",
    "tradingVenue": "TRADING_VENUE_TDX",
    "usSecIRS": "US_SECURITY_DOMICILE_IN_SWISS",
    "euTax": "EU_TAX_UNKNOWN",
    "openingDate": "2024-01-15T09:30:00Z",
    "closingDate": "2024-01-15T09:30:00Z",
    "primarySegment": "PRIMARY_SEGMENT_SWISS_EQUITIES",
    "sector": "SECTOR_TECH",
    "marketType": "MARKET_TYPE_PRIMARY",
    "contractAddress": "string",
    "depositary": "DEPOSITARY_NONE",
    "finSAInvestorClassifications": [
      "FIN_SA_INVESTOR_CLASSIFICATION_RETAIL"
    ],
    "attributes": [
      {
        "id": "string",
        "owner": "string",
        "type": "string",
        "subType": "string",
        "key": "string",
        "value": "string",
        "contentType": "string",
        "isFile": true,
        "createdAt": "2024-01-15T09:30:00Z",
        "updatedAt": "2024-01-15T09:30:00Z"
      }
    ],
    "issuer": {
      "id": "string",
      "name": "string",
      "attributes": [
        {
          "id": "string",
          "owner": "string",
          "type": "string",
          "subType": "string",
          "key": "string",
          "value": "string",
          "contentType": "string",
          "isFile": true
        }
      ]
    },
    "offering": {
      "completion": "string",
      "startedAt": "2024-01-15T09:30:00Z",
      "endedAt": "2024-01-15T09:30:00Z",
      "timeRemaining": "string"
    },
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "blockchain": "string",
    "decimals": 1,
    "nominalValue": "string",
    "mainTradingCurrency": "MAIN_TRADING_CURRENCY_NONE",
    "depositEnabled": true,
    "withdrawalEnabled": true,
    "displaySymbol": "string",
    "documents": [
      {
        "instrumentId": "string",
        "documentId": "string",
        "confirmationType": "DOCUMENT_CONFIRMATION_TYPE_SIGNATURE"
      }
    ],
    "exclusiveGroupId": "string",
    "presentationContent": {
      "bondPresentationContent": {
        "tradingPrice": "TRADING_PRICE_CLEAN",
        "maturityDate": "2024-01-15T09:30:00Z",
        "issuanceDate": "2024-01-15T09:30:00Z",
        "principalAmount": "string",
        "totalIssuanceAmount": "string",
        "interestRate": "string",
        "couponType": "COUPON_TYPE_FIXED",
        "couponPaymentFrequency": 1,
        "callable": true,
        "callProtection": "string",
        "puttable": true,
        "putProtection": "string",
        "amortizationScheme": {
          "repaymentAmount": "string",
          "repaymentFrequency": 1
        }
      }
    },
    "nativeCurrency": true,
    "blockchainInfo": {
      "id": "string",
      "name": "string",
      "symbol": "string",
      "network": "string"
    }
  }
}

This endpoint returns an instrument

Path parameters

idstringRequired

Query parameters

fieldslist of stringsOptional

Response

A successful response.

resultobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error