# Models ## The OrderKindEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"OrderKindEnum":{"type":"string","enum":["BUY","SELL"]}}}} ``` ## The FinalityStatusEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinalityStatusEnum":{"type":"string","enum":["NON_FINAL","FINAL"]}}}} ``` ## The BlockChainEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"BlockChainEnum":{"type":"string","enum":["POLYGON","STELLAR"]}}}} ``` ## The FinancialInstrumentAssetTypeEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentAssetTypeEnum":{"type":"string","enum":["C_COLLECTIVE_INVESTMENT_VEHICLES","D_DEBT_INSTRUMENTS","E_EQUITIES","F_FUTURES","H_NON_LISTED_COMPLEX_OPTIONS","J_FORWARDS","O_LISTED_OPTIONS","R_ENTITLEMENT","S_SWAPS","I_SPOT"]}}}} ``` ## The FinancialInstrumentAssetSubtypeEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentAssetSubtypeEnum":{"type":"string","enum":["C_I","C_H","C_B","C_E","C_S","C_F","C_P","C_M","D_B","D_C","D_W","D_T","D_Y","D_S","D_E","D_G","D_A","D_N","D_D","D_M","E_S","E_P","E_C","E_F","E_L","E_D","E_Y","E_M","F_F","F_C","H_R","H_T","H_E","H_C","H_F","H_M","J_E","J_F","J_C","J_R","J_T","O_C","O_P","O_M","R_A","R_S","R_P","R_W","R_F","R_D","R_M","S_R","S_T","S_E","S_C","S_F","S_M","I_F","I_T"]}}}} ``` ## The IndexDefinitionEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"IndexDefinitionEnum":{"type":"string","enum":["OTHR","EONA","EONS","EURI","EUUS","EUCH","GCFR","ISDA","LIBI","LIBO","MAAA","PFAN","TIBO","STBO","BBSW","JIBA","BUBO","CDOR","CIBO","MOSP","NIBO","PRBO","TLBO","WIBO","TREA","SWAP","FUSW"]}}}} ``` ## The CommodityDerivativesProductEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"CommodityDerivativesProductEnum":{"type":"string","enum":["AGRI","NRGY","ENVR","FRGT","FRTL","INDP","METL","MCEX","PAPR","POLY","INFL","OEST","OTHC","OTHR"]}}}} ``` ## The CommodityDerivativesSubProductEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"CommodityDerivativesSubProductEnum":{"type":"string","enum":["GROS","SOFT","POTA","OOLI","DIRY","FRST","SEAF","LSTK","GRIN","ELEC","NGAS","OILP","COAL","INRG","RNNG","LGHT","DIST","EMIS","WTHR","CRBR","WETF","DRYF","CSHP","AMMO","DAPH","PTSH","SLPH","UREA","UAAN","CSTR","MFTG","NPRM","PRME","CBRD","NSPT","PULP","RCVP","PLST","DLVR","NDLV"]}}}} ``` ## The CommodityDerivativesFurtherSubProductEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"CommodityDerivativesFurtherSubProductEnum":{"type":"string","enum":["FWHT","SOYB","CORN","RPSD","RICE","OTHR","CCOA","ROBU","WHSG","BRWN","LAMP","MWHT","BSLD","FITR","PKLD","OFFP","GASP","LNGG","NBPG","NCGG","TTFG","BAKK","BDSL","BRNT","BRNX","CNDA","COND","DSEL","DUBA","ESPO","ETHA","FUEL","FOIL","GOIL","GSLN","HEAT","JTFL","KERO","LLSO","MARS","NAPH","NGLO","TAPI","URAL","WTIO","CERE","ERUE","EUAE","EUAA","TNKR","DBCR","ALUM","ALUA","CBLT","COPR","IRON","LEAD","MOLY","NASC","NICK","STEL","TINN","ZINC","GOLD","SLVR","PTNM","PLDM"]}}}} ``` ## The MifirIdentifierEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"MifirIdentifierEnum":{"type":"string","enum":["SDRV","SFPS","BOND","ETCS","ETNS","EMAL","DERV","SHRS","ETFS","DPRS","CRFT","OTHR","NA"]}}}} ``` ## The FinancialInstrumentStatusEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentStatusEnum":{"type":"string","enum":["CREATED","APPROVED","ACTIVE","EXPIRED","DEACTIVATED"]}}}} ``` ## The AssetClassOfUnderlyingEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"AssetClassOfUnderlyingEnum":{"type":"string","enum":["INTR","EQUI","COMM","CRDT","CURR","EMAL","OCTN"]}}}} ``` ## The FinancialInstrumentContractTypeEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentContractTypeEnum":{"type":"string","enum":["OPTN","FUTR","FRAS","FORW","SWAP","PSWP","SWPT","OPTS","FONS","FWOS","SPDB","CFDS","OTHR"]}}}} ``` ## The FinancialInstrumentLinkedEntityTypeEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentLinkedEntityTypeEnum":{"type":"string","enum":["DISTRIBUTOR","FUND_ADMINISTRATOR","TOKENIZER","MARKET_MAKER","SUPERVISORY_AUTHORITY","PORTFOLIO_MANAGER","MANAGEMENT_COMPANY","INVESTMENT_MANAGER","EXECUTION_AGENT","BROKER","LISTING_SPONSOR","REGISTRAR","UNDERLYING_ISSUER"]}}}} ``` ## The FinancialInstrumentClassificationEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentClassificationEnum":{"type":"string","enum":["RETAIL","PROFESSIONAL"]}}}} ``` ## The FinancialInstrumentDistributionEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentDistributionEnum":{"type":"string","enum":["NATURAL_PERSON","LEGAL_ENTITY"]}}}} ``` ## The FinancialInstrumentUseOfIncomeTypeEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentUseOfIncomeTypeEnum":{"type":"string","enum":["ACCUMULATING","DISTRIBUTING"]}}}} ``` ## The FinancialInstrumentIndexTermUnitEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentIndexTermUnitEnum":{"type":"string","enum":["DAYS","WEEK","MNTH","YEAR"]}}}} ``` ## The FinancialInstrumentSeniorityEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentSeniorityEnum":{"type":"string","enum":["SNDB","MZZD","SBOD","JUND"]}}}} ``` ## The FinancialInstrumentBondTypeEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentBondTypeEnum":{"type":"string","enum":["EUSB","OEPB","CVTB","CVDB","CRPB","OTHR"]}}}} ``` ## The FinancialInstrumentOptionTypeEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentOptionTypeEnum":{"type":"string","enum":["PUTO","CALL","OTHR"]}}}} ``` ## The FinancialInstrumentOptionExcerciseStyleEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentOptionExcerciseStyleEnum":{"type":"string","enum":["EURO","AMER","ASIA","BERM","OTHR"]}}}} ``` ## The FinancialInstrumentStrikePriceTypeEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentStrikePriceTypeEnum":{"type":"string","enum":["MONE","PERC","YIEL","BIPS","PNDG"]}}}} ``` ## The FinancialInstrumentDeliveryTypeEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentDeliveryTypeEnum":{"type":"string","enum":["PHYS","CASH","OPTL"]}}}} ``` ## The EquityDerivativeUnderlyingTypeEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"EquityDerivativeUnderlyingTypeEnum":{"type":"string","enum":["STIX","SHRS","DIVI","DVSE","BSKT","ETFS","VOLI","OTHR"]}}}} ``` ## The EquityDerivativeParameterTypeEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"EquityDerivativeParameterTypeEnum":{"type":"string","enum":["PRBP","PRDV","PRVA","PRVO"]}}}} ``` ## The CommodityDerivativeTransactionTypeEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"CommodityDerivativeTransactionTypeEnum":{"type":"string","enum":["FUTR","OPTN","TAPO","SWAP","MINI","OTCT","ORIT","CRCK","DIFF","OTHR"]}}}} ``` ## The CommodityDerivativeFinalPriceTypeEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"CommodityDerivativeFinalPriceTypeEnum":{"type":"string","enum":["ARGM","BLTC","EXOF","GBCL","IHSM","PLAT","OTHR"]}}}} ``` ## The CommodityDerivativeSizeSpecificationEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"CommodityDerivativeSizeSpecificationEnum":{"type":"string","enum":["CAPE","PNMX","SPMX","HAND","CLAN","DRTY"]}}}} ``` ## The EmissionAllowanceSubTypeEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"EmissionAllowanceSubTypeEnum":{"type":"string","enum":["CERE","ERUE","EUAE","EUAA","OTHR"]}}}} ``` ## The InterestRateDerivativeUnderlyingTypeEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"InterestRateDerivativeUnderlyingTypeEnum":{"type":"string","enum":["BOND","BNDF","INTR","IFUT","FFMC","XFMC","XXMC","OSMC","IFMC","FFSC","XFSC","XXSC","OSSC","IFSC"]}}}} ``` ## The ForeignExchangeDerivativeTypeEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"ForeignExchangeDerivativeTypeEnum":{"type":"string","enum":["FXCR","FXEM","FXMJ"]}}}} ``` ## The ForeignExchangeDerivativeContractSubTypeEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"ForeignExchangeDerivativeContractSubTypeEnum":{"type":"string","enum":["DLVB","NDLV"]}}}} ``` ## The ContractsForDifferenceUnderlyingTypeEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"ContractsForDifferenceUnderlyingTypeEnum":{"type":"string","enum":["CURR","EQUI","BOND","FTEQ","OPEQ","COMM","EMAL","OTHR"]}}}} ``` ## The TradingStatusEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"TradingStatusEnum":{"type":"string","enum":["CREATED","CONTINUOUS_TRADING","OUT_OF_TRADING","AUTOMATIC_TRADING_HALT","MANUAL_TRADING_HALT","DISABLED","PERMANENTLY_DELETED"]}}}} ``` ## The TradingStatusChangeReasonEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"TradingStatusChangeReasonEnum":{"type":"string","enum":["START_OF_TRADING_DAY","MANUAL_MARKET_OPEN","END_OF_TRADING_DAY","MANUAL_MARKET_CLOSE","REGULATOR_INITIATED_HALT","PARTICIPANT_INITIATED_HALT","VENUE_INITIATED_HALT","CAPACITY_LIMIT_HALT","VOLATILITY_HALT","TECHNICAL_HALT","TRADING_PAIR_ACTIVATION","TRADING_PAIR_DEACTIVATION","TRADING_PAIR_OFFBOARDING","TRADING_PAIR_CREATION","AUTOMATIC_RESUME"]}}}} ``` ## The OrderTypeEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"OrderTypeEnum":{"type":"string","enum":["LIMIT","MARKET"]}}}} ``` ## The OrderStatusEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"OrderStatusEnum":{"type":"string","enum":["OPEN","COMPLETED","CANCELLED","REJECTED","CANCELLED_PARTIAL","REJECTED_PARTIAL"]}}}} ``` ## The OrderQuantityTypeEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"OrderQuantityTypeEnum":{"type":"string","enum":["UNIT","MONEY"]}}}} ``` ## The OrderStatusReasonEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"OrderStatusReasonEnum":{"type":"string","enum":["N_A","EXECUTED_SUCCESSFULLY","CREATOR_CANCEL","ADMIN_CANCEL","PARTICIPANT_REQUEST","MARKET_CLOSE","AUTHORITY_REQUEST","VENUE_REQUEST","OTHER","SELF_TRADE","TOO_MANY_MATCHES","TICK_SIZE_VIOLATION","MINIMUM_VOLUME","MAXIMUM_VOLUME","MINIMUM_VALUE","MAXIMUM_VALUE","PRICE_COLLAR","UPPER_STATIC_PRICE_RANGE","LOWER_STATIC_PRICE_RANGE","UPPER_DYNAMIC_PRICE_RANGE","LOWER_DYNAMIC_PRICE_RANGE","EXECUTION_CONDITION_FOK","EXECUTION_CONDITION_IOC","EXECUTION_CONDITION_BOC"]}}}} ``` ## The OrderExecutionConditionEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"OrderExecutionConditionEnum":{"type":"string","enum":["NONE","FILL_OR_KILL","IMMEDIATE_OR_CANCEL","BOOK_OR_CANCEL"]}}}} ``` ## The WalletStatusEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"WalletStatusEnum":{"type":"string","enum":["CREATED","IN_VERIFICATION","VERIFIED","REMOVED","BLOCKED"]}}}} ``` ## The WalletDesignationEnum object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"WalletDesignationEnum":{"type":"string","enum":["TRADING","MARKET_MAKER"]}}}} ``` ## The AddressData object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"AddressData":{"required":["countryCode","areaCode","city","street"],"type":"object","properties":{"countryCode":{"type":"string","pattern":"^[A-Z]{2}$","maxLength":2},"areaCode":{"type":"string","maxLength":50},"city":{"type":"string","maxLength":50},"street":{"type":"string","maxLength":50},"postOfficeBox":{"type":"string","maxLength":50},"addressSupplement":{"type":"string","maxLength":255}}}}}} ``` ## The FinancialInstrumentTableBase object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentTableBase":{"type":"object","properties":{"symbol":{"description":"The financial instrument's symbol\n","type":"string","maxLength":255},"fullName":{"description":"The financial instrument's name\n","type":"string","maxLength":255},"status":{"description":"Trading status of the financial instrument\n","$ref":"#/components/schemas/FinancialInstrumentStatusEnum","readOnly":true},"isin":{"description":"International Securities Identification Number (ISIN) of the financial instrument\n","type":"string","pattern":"^[A-Z]{2}[0-9A-Z]{9}[0-9]$","maxLength":255},"dti":{"description":"Digital Token Identifier (DTI) of the financial instrument\n","type":"string","maxLength":255},"issuerName":{"description":"Name of the issuer of the financial instrument\n","type":"string","maxLength":255},"prospectusLink":{"description":"Link to further information about the financial instrument\n","type":"string","readOnly":true,"maxLength":255},"effectiveDate":{"description":"First day of active trading on 21X\n","type":"string","format":"date-time"},"terminationDate":{"description":"Last day of trading on 21X\n","type":"string","format":"date-time"},"smartContractAddress":{"description":"The blockchain address of the financial instrument's smart contract\n","type":"string","pattern":"^(0x)?[0-9a-fA-F]+$","maxLength":255}}},"FinancialInstrumentStatusEnum":{"type":"string","enum":["CREATED","APPROVED","ACTIVE","EXPIRED","DEACTIVATED"]}}}} ``` ## The FinancialInstrumentUnderlyingInstrumentData object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentUnderlyingInstrumentData":{"type":"object","properties":{"isin":{"type":"string","pattern":"^[A-Z]{2}[0-9A-Z]{9}[0-9]$","maxLength":255},"issuerLei":{"type":"string","pattern":"^[0-9A-Z]{18}[0-9]{2}$","maxLength":255},"index":{"$ref":"#/components/schemas/IndexDefinitionEnum"},"indexName":{"type":"string","maxLength":25},"indexTermUnit":{"$ref":"#/components/schemas/FinancialInstrumentIndexTermUnitEnum"},"indexTermValue":{"type":"integer","format":"int32","minimum":0}}},"IndexDefinitionEnum":{"type":"string","enum":["OTHR","EONA","EONS","EURI","EUUS","EUCH","GCFR","ISDA","LIBI","LIBO","MAAA","PFAN","TIBO","STBO","BBSW","JIBA","BUBO","CDOR","CIBO","MOSP","NIBO","PRBO","TLBO","WIBO","TREA","SWAP","FUSW"]},"FinancialInstrumentIndexTermUnitEnum":{"type":"string","enum":["DAYS","WEEK","MNTH","YEAR"]}}}} ``` ## The FinancialInstrumentLinkedEntityData object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentLinkedEntityData":{"required":["entityType"],"type":"object","properties":{"entityType":{"$ref":"#/components/schemas/FinancialInstrumentLinkedEntityTypeEnum"},"entityId":{"type":"string","maxLength":255},"entityName":{"type":"string","maxLength":255}}},"FinancialInstrumentLinkedEntityTypeEnum":{"type":"string","enum":["DISTRIBUTOR","FUND_ADMINISTRATOR","TOKENIZER","MARKET_MAKER","SUPERVISORY_AUTHORITY","PORTFOLIO_MANAGER","MANAGEMENT_COMPANY","INVESTMENT_MANAGER","EXECUTION_AGENT","BROKER","LISTING_SPONSOR","REGISTRAR","UNDERLYING_ISSUER"]}}}} ``` ## The FinancialInstrumentAvailabilityData object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentAvailabilityData":{"type":"object","properties":{"classification":{"type":"array","items":{"$ref":"#/components/schemas/FinancialInstrumentClassificationEnum"}},"distribution":{"type":"array","items":{"$ref":"#/components/schemas/FinancialInstrumentDistributionEnum"}},"jurisdictions":{"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}$","maxLength":255}}}},"FinancialInstrumentClassificationEnum":{"type":"string","enum":["RETAIL","PROFESSIONAL"]},"FinancialInstrumentDistributionEnum":{"type":"string","enum":["NATURAL_PERSON","LEGAL_ENTITY"]}}}} ``` ## The FinancialInstrumentDisplayData object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentDisplayData":{"type":"object","properties":{"assetType":{"$ref":"#/components/schemas/FinancialInstrumentAssetTypeEnum","readOnly":true},"subAssetType":{"$ref":"#/components/schemas/FinancialInstrumentAssetSubtypeEnum","readOnly":true},"prospectusLink":{"type":"string","maxLength":255},"description":{"type":"string","maxLength":2000},"replication":{"type":"string","maxLength":100},"investmentStyle":{"type":"string","maxLength":100},"useOfIncome":{"$ref":"#/components/schemas/FinancialInstrumentUseOfIncomeTypeEnum"},"instrumentName":{"type":"string","maxLength":255},"instrumentNickname":{"type":"string","maxLength":255},"underlyingInstrumentName":{"type":"string","maxLength":255},"underlyingInstrumentNickname":{"type":"string","maxLength":255},"linkToUnderlying":{"type":"string","maxLength":255}}},"FinancialInstrumentAssetTypeEnum":{"type":"string","enum":["C_COLLECTIVE_INVESTMENT_VEHICLES","D_DEBT_INSTRUMENTS","E_EQUITIES","F_FUTURES","H_NON_LISTED_COMPLEX_OPTIONS","J_FORWARDS","O_LISTED_OPTIONS","R_ENTITLEMENT","S_SWAPS","I_SPOT"]},"FinancialInstrumentAssetSubtypeEnum":{"type":"string","enum":["C_I","C_H","C_B","C_E","C_S","C_F","C_P","C_M","D_B","D_C","D_W","D_T","D_Y","D_S","D_E","D_G","D_A","D_N","D_D","D_M","E_S","E_P","E_C","E_F","E_L","E_D","E_Y","E_M","F_F","F_C","H_R","H_T","H_E","H_C","H_F","H_M","J_E","J_F","J_C","J_R","J_T","O_C","O_P","O_M","R_A","R_S","R_P","R_W","R_F","R_D","R_M","S_R","S_T","S_E","S_C","S_F","S_M","I_F","I_T"]},"FinancialInstrumentUseOfIncomeTypeEnum":{"type":"string","enum":["ACCUMULATING","DISTRIBUTING"]}}}} ``` ## The FinancialInstrumentPerformanceData object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentPerformanceData":{"type":"object","properties":{"nav":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"navCurrency":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"navLastUpdate":{"type":"string","format":"date"},"navSource":{"type":"string","maxLength":255},"totalExpenseRatio":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"assetsUnderManagement":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"assetsUnderManagementCurrency":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"assetsUnderManagementLastUpdate":{"type":"string","format":"date"}}}}}} ``` ## The FinancialInstrumentIndexBenchmarkData object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentIndexBenchmarkData":{"type":"object","properties":{"isin":{"type":"string","pattern":"^[A-Z]{2}[0-9A-Z]{9}[0-9]$","maxLength":255},"index":{"$ref":"#/components/schemas/IndexDefinitionEnum"},"indexName":{"type":"string","maxLength":25},"indexTermUnit":{"$ref":"#/components/schemas/FinancialInstrumentIndexTermUnitEnum"},"indexTermValue":{"type":"integer","format":"int32","minimum":0},"basePointSpread":{"type":"integer","format":"int32","minimum":0}}},"IndexDefinitionEnum":{"type":"string","enum":["OTHR","EONA","EONS","EURI","EUUS","EUCH","GCFR","ISDA","LIBI","LIBO","MAAA","PFAN","TIBO","STBO","BBSW","JIBA","BUBO","CDOR","CIBO","MOSP","NIBO","PRBO","TLBO","WIBO","TREA","SWAP","FUSW"]},"FinancialInstrumentIndexTermUnitEnum":{"type":"string","enum":["DAYS","WEEK","MNTH","YEAR"]}}}} ``` ## The FinancialInstrumentDebtInstrumentData object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentDebtInstrumentData":{"type":"object","properties":{"totalIssuedNominalAmount":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"maturityDate":{"type":"string","format":"date"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"minimumTradedValue":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"fixedRate":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"bondSeniority":{"$ref":"#/components/schemas/FinancialInstrumentSeniorityEnum"},"bondType":{"$ref":"#/components/schemas/FinancialInstrumentBondTypeEnum"},"bondIssuanceDate":{"type":"string","format":"date"},"indexBenchmark":{"$ref":"#/components/schemas/FinancialInstrumentIndexBenchmarkData"}}},"FinancialInstrumentSeniorityEnum":{"type":"string","enum":["SNDB","MZZD","SBOD","JUND"]},"FinancialInstrumentBondTypeEnum":{"type":"string","enum":["EUSB","OEPB","CVTB","CVDB","CRPB","OTHR"]},"FinancialInstrumentIndexBenchmarkData":{"type":"object","properties":{"isin":{"type":"string","pattern":"^[A-Z]{2}[0-9A-Z]{9}[0-9]$","maxLength":255},"index":{"$ref":"#/components/schemas/IndexDefinitionEnum"},"indexName":{"type":"string","maxLength":25},"indexTermUnit":{"$ref":"#/components/schemas/FinancialInstrumentIndexTermUnitEnum"},"indexTermValue":{"type":"integer","format":"int32","minimum":0},"basePointSpread":{"type":"integer","format":"int32","minimum":0}}},"IndexDefinitionEnum":{"type":"string","enum":["OTHR","EONA","EONS","EURI","EUUS","EUCH","GCFR","ISDA","LIBI","LIBO","MAAA","PFAN","TIBO","STBO","BBSW","JIBA","BUBO","CDOR","CIBO","MOSP","NIBO","PRBO","TLBO","WIBO","TREA","SWAP","FUSW"]},"FinancialInstrumentIndexTermUnitEnum":{"type":"string","enum":["DAYS","WEEK","MNTH","YEAR"]}}}} ``` ## The FinancialInstrumentDerivativeData object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentDerivativeData":{"type":"object","properties":{"expiryDate":{"type":"string","format":"date"},"priceMultiplier":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"optionType":{"$ref":"#/components/schemas/FinancialInstrumentOptionTypeEnum"},"strikePriceType":{"$ref":"#/components/schemas/FinancialInstrumentStrikePriceTypeEnum"},"strikePriceValue":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"strikePriceCurrency":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"optionExerciseStyle":{"$ref":"#/components/schemas/FinancialInstrumentOptionExcerciseStyleEnum"},"deliveryType":{"$ref":"#/components/schemas/FinancialInstrumentDeliveryTypeEnum"},"equityDerivativeUnderlyingType":{"$ref":"#/components/schemas/EquityDerivativeUnderlyingTypeEnum"},"equityDerivativeParameter":{"$ref":"#/components/schemas/EquityDerivativeParameterTypeEnum"},"underlyingInstruments":{"type":"array","items":{"$ref":"#/components/schemas/FinancialInstrumentUnderlyingInstrumentData"}}}},"FinancialInstrumentOptionTypeEnum":{"type":"string","enum":["PUTO","CALL","OTHR"]},"FinancialInstrumentStrikePriceTypeEnum":{"type":"string","enum":["MONE","PERC","YIEL","BIPS","PNDG"]},"FinancialInstrumentOptionExcerciseStyleEnum":{"type":"string","enum":["EURO","AMER","ASIA","BERM","OTHR"]},"FinancialInstrumentDeliveryTypeEnum":{"type":"string","enum":["PHYS","CASH","OPTL"]},"EquityDerivativeUnderlyingTypeEnum":{"type":"string","enum":["STIX","SHRS","DIVI","DVSE","BSKT","ETFS","VOLI","OTHR"]},"EquityDerivativeParameterTypeEnum":{"type":"string","enum":["PRBP","PRDV","PRVA","PRVO"]},"FinancialInstrumentUnderlyingInstrumentData":{"type":"object","properties":{"isin":{"type":"string","pattern":"^[A-Z]{2}[0-9A-Z]{9}[0-9]$","maxLength":255},"issuerLei":{"type":"string","pattern":"^[0-9A-Z]{18}[0-9]{2}$","maxLength":255},"index":{"$ref":"#/components/schemas/IndexDefinitionEnum"},"indexName":{"type":"string","maxLength":25},"indexTermUnit":{"$ref":"#/components/schemas/FinancialInstrumentIndexTermUnitEnum"},"indexTermValue":{"type":"integer","format":"int32","minimum":0}}},"IndexDefinitionEnum":{"type":"string","enum":["OTHR","EONA","EONS","EURI","EUUS","EUCH","GCFR","ISDA","LIBI","LIBO","MAAA","PFAN","TIBO","STBO","BBSW","JIBA","BUBO","CDOR","CIBO","MOSP","NIBO","PRBO","TLBO","WIBO","TREA","SWAP","FUSW"]},"FinancialInstrumentIndexTermUnitEnum":{"type":"string","enum":["DAYS","WEEK","MNTH","YEAR"]}}}} ``` ## The FinancialInstrumentCommodityDerivativeData object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentCommodityDerivativeData":{"type":"object","properties":{"baseProduct":{"$ref":"#/components/schemas/CommodityDerivativesProductEnum"},"subProduct":{"$ref":"#/components/schemas/CommodityDerivativesSubProductEnum"},"furtherSubProduct":{"$ref":"#/components/schemas/CommodityDerivativesFurtherSubProductEnum"},"transactionType":{"$ref":"#/components/schemas/CommodityDerivativeTransactionTypeEnum"},"finalPriceType":{"$ref":"#/components/schemas/CommodityDerivativeFinalPriceTypeEnum"},"sizeSpecification":{"$ref":"#/components/schemas/CommodityDerivativeSizeSpecificationEnum"},"freightRoute":{"type":"string","maxLength":6},"settlementLocation":{"type":"string","maxLength":16},"commodityNotionalCurrency":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"emissionAllowanceSubType":{"$ref":"#/components/schemas/EmissionAllowanceSubTypeEnum"}}},"CommodityDerivativesProductEnum":{"type":"string","enum":["AGRI","NRGY","ENVR","FRGT","FRTL","INDP","METL","MCEX","PAPR","POLY","INFL","OEST","OTHC","OTHR"]},"CommodityDerivativesSubProductEnum":{"type":"string","enum":["GROS","SOFT","POTA","OOLI","DIRY","FRST","SEAF","LSTK","GRIN","ELEC","NGAS","OILP","COAL","INRG","RNNG","LGHT","DIST","EMIS","WTHR","CRBR","WETF","DRYF","CSHP","AMMO","DAPH","PTSH","SLPH","UREA","UAAN","CSTR","MFTG","NPRM","PRME","CBRD","NSPT","PULP","RCVP","PLST","DLVR","NDLV"]},"CommodityDerivativesFurtherSubProductEnum":{"type":"string","enum":["FWHT","SOYB","CORN","RPSD","RICE","OTHR","CCOA","ROBU","WHSG","BRWN","LAMP","MWHT","BSLD","FITR","PKLD","OFFP","GASP","LNGG","NBPG","NCGG","TTFG","BAKK","BDSL","BRNT","BRNX","CNDA","COND","DSEL","DUBA","ESPO","ETHA","FUEL","FOIL","GOIL","GSLN","HEAT","JTFL","KERO","LLSO","MARS","NAPH","NGLO","TAPI","URAL","WTIO","CERE","ERUE","EUAE","EUAA","TNKR","DBCR","ALUM","ALUA","CBLT","COPR","IRON","LEAD","MOLY","NASC","NICK","STEL","TINN","ZINC","GOLD","SLVR","PTNM","PLDM"]},"CommodityDerivativeTransactionTypeEnum":{"type":"string","enum":["FUTR","OPTN","TAPO","SWAP","MINI","OTCT","ORIT","CRCK","DIFF","OTHR"]},"CommodityDerivativeFinalPriceTypeEnum":{"type":"string","enum":["ARGM","BLTC","EXOF","GBCL","IHSM","PLAT","OTHR"]},"CommodityDerivativeSizeSpecificationEnum":{"type":"string","enum":["CAPE","PNMX","SPMX","HAND","CLAN","DRTY"]},"EmissionAllowanceSubTypeEnum":{"type":"string","enum":["CERE","ERUE","EUAE","EUAA","OTHR"]}}}} ``` ## The UnderlyingInterestRateDerivativeBondData object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"UnderlyingInterestRateDerivativeBondData":{"type":"object","properties":{"issuerLei":{"type":"string","pattern":"^[0-9A-Z]{18}[0-9]{2}$","maxLength":255},"maturityDate":{"type":"string","format":"date"},"issuanceDate":{"type":"string","format":"date"}}}}}} ``` ## The UnderlyingInterestRateDerivativeSwapData object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"UnderlyingInterestRateDerivativeSwapData":{"type":"object","properties":{"notionalCurrency":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"maturityDate":{"type":"string","format":"date"}}}}}} ``` ## The FinancialInstrumentInterestRateDerivativeData object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentInterestRateDerivativeData":{"type":"object","properties":{"referenceRateIndex":{"$ref":"#/components/schemas/IndexDefinitionEnum"},"referenceRateName":{"type":"string","maxLength":25},"interestRateTermUnit":{"$ref":"#/components/schemas/FinancialInstrumentIndexTermUnitEnum"},"interestRateTermValue":{"type":"integer","format":"int32","minimum":0},"notionalCurrency2":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"fixedRateLeg1":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"fixedRateLeg2":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"floatingRateLeg2Index":{"$ref":"#/components/schemas/IndexDefinitionEnum"},"floatingRateLeg2Name":{"type":"string","maxLength":25},"interestRateLeg2TermUnit":{"$ref":"#/components/schemas/FinancialInstrumentIndexTermUnitEnum"},"interestRateLeg2TermValue":{"type":"integer","format":"int32","minimum":0},"underlyingInterestRateDerivativeType":{"$ref":"#/components/schemas/InterestRateDerivativeUnderlyingTypeEnum"},"underlyingInterestRateDerivativeIsin":{"type":"string","pattern":"^[A-Z]{2}[0-9A-Z]{9}[0-9]$","maxLength":255},"underlyingInterestRateDerivativeIndexName":{"type":"string","maxLength":25},"underlyingInterestRateDerivativeReferenceRateIndex":{"$ref":"#/components/schemas/IndexDefinitionEnum"},"underlyingInterestRateDerivativeReferenceRateName":{"type":"string","maxLength":25},"underlyingInterestRateDerivativeTermUnit":{"$ref":"#/components/schemas/FinancialInstrumentIndexTermUnitEnum"},"underlyingInterestRateDerivativeTermValue":{"type":"integer","format":"int32","minimum":0},"underlyingInterestRateDerivativeBond":{"$ref":"#/components/schemas/UnderlyingInterestRateDerivativeBondData"},"underlyingInterestRateDerivativeSwap":{"$ref":"#/components/schemas/UnderlyingInterestRateDerivativeSwapData"}}},"IndexDefinitionEnum":{"type":"string","enum":["OTHR","EONA","EONS","EURI","EUUS","EUCH","GCFR","ISDA","LIBI","LIBO","MAAA","PFAN","TIBO","STBO","BBSW","JIBA","BUBO","CDOR","CIBO","MOSP","NIBO","PRBO","TLBO","WIBO","TREA","SWAP","FUSW"]},"FinancialInstrumentIndexTermUnitEnum":{"type":"string","enum":["DAYS","WEEK","MNTH","YEAR"]},"InterestRateDerivativeUnderlyingTypeEnum":{"type":"string","enum":["BOND","BNDF","INTR","IFUT","FFMC","XFMC","XXMC","OSMC","IFMC","FFSC","XFSC","XXSC","OSSC","IFSC"]},"UnderlyingInterestRateDerivativeBondData":{"type":"object","properties":{"issuerLei":{"type":"string","pattern":"^[0-9A-Z]{18}[0-9]{2}$","maxLength":255},"maturityDate":{"type":"string","format":"date"},"issuanceDate":{"type":"string","format":"date"}}},"UnderlyingInterestRateDerivativeSwapData":{"type":"object","properties":{"notionalCurrency":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"maturityDate":{"type":"string","format":"date"}}}}}} ``` ## The FinancialInstrumentForeignExchangeDerivativeData object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentForeignExchangeDerivativeData":{"type":"object","properties":{"notionalCurrency2":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"foreignExchangeType":{"$ref":"#/components/schemas/ForeignExchangeDerivativeTypeEnum"},"foreignExchangeContractSubType":{"$ref":"#/components/schemas/ForeignExchangeDerivativeContractSubTypeEnum"}}},"ForeignExchangeDerivativeTypeEnum":{"type":"string","enum":["FXCR","FXEM","FXMJ"]},"ForeignExchangeDerivativeContractSubTypeEnum":{"type":"string","enum":["DLVB","NDLV"]}}}} ``` ## The FinancialInstrumentEmissionAllowanceData object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentEmissionAllowanceData":{"type":"object","properties":{"subType":{"$ref":"#/components/schemas/EmissionAllowanceSubTypeEnum"}}},"EmissionAllowanceSubTypeEnum":{"type":"string","enum":["CERE","ERUE","EUAE","EUAA","OTHR"]}}}} ``` ## The FinancialInstrumentContractsForDifferenceData object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentContractsForDifferenceData":{"type":"object","properties":{"underlyingType":{"$ref":"#/components/schemas/ContractsForDifferenceUnderlyingTypeEnum"},"notionalCurrency1":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"notionalCurrency2":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255}}},"ContractsForDifferenceUnderlyingTypeEnum":{"type":"string","enum":["CURR","EQUI","BOND","FTEQ","OPEQ","COMM","EMAL","OTHR"]}}}} ``` ## The FinancialInstrumentCreditDerivativeData object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentCreditDerivativeData":{"type":"object","properties":{"underlyingSwapIsin":{"type":"string","pattern":"^[A-Z]{2}[0-9A-Z]{9}[0-9]$","maxLength":255},"underlyingIndexIsin":{"type":"string","pattern":"^[A-Z]{2}[0-9A-Z]{9}[0-9]$","maxLength":255},"underlyingIndexName":{"type":"string","maxLength":25},"series":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"version":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"rollMonths":{"type":"array","items":{"type":"string","pattern":"^((0[1-9])|(1[012]))$","maxLength":255}},"nextRollDate":{"type":"string","format":"date"},"issuerSovereignPublic":{"type":"boolean","default":false},"referenceObligationIsin":{"type":"string","pattern":"^[A-Z]{2}[0-9A-Z]{9}[0-9]$","maxLength":255},"referenceEntityCountry":{"type":"string","pattern":"^[A-Z]{2}$","maxLength":255},"referenceEntitySubDivision":{"type":"string","maxLength":6},"referenceEntityLei":{"type":"string","pattern":"^[0-9A-Z]{18}[0-9]{2}$","maxLength":255},"referenceEntityNotionalCurrency":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255}}}}}} ``` ## The PublicIssuerData object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"PublicIssuerData":{"type":"object","properties":{"companyName":{"type":"string","maxLength":255},"website":{"type":"string","maxLength":255},"legalAddress":{"$ref":"#/components/schemas/AddressData"},"legalEntityIdentifier":{"type":"string","pattern":"^[0-9A-Z]{18}[0-9]{2}$","maxLength":255}}},"AddressData":{"required":["countryCode","areaCode","city","street"],"type":"object","properties":{"countryCode":{"type":"string","pattern":"^[A-Z]{2}$","maxLength":2},"areaCode":{"type":"string","maxLength":50},"city":{"type":"string","maxLength":50},"street":{"type":"string","maxLength":50},"postOfficeBox":{"type":"string","maxLength":50},"addressSupplement":{"type":"string","maxLength":255}}}}}} ``` ## The FinancialInstrumentPublic object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentPublic":{"required":["fullName"],"type":"object","properties":{"status":{"$ref":"#/components/schemas/FinancialInstrumentStatusEnum","readOnly":true,"default":"CREATED"},"domicile":{"type":"string","pattern":"^[A-Z]{2}$","maxLength":255},"wkn":{"type":"string","maxLength":6},"sedol":{"type":"string","maxLength":7},"cusip":{"type":"string","maxLength":9},"valor":{"type":"string","maxLength":50},"dti":{"type":"string","maxLength":9},"symbol":{"type":"string","maxLength":10},"protocol":{"$ref":"#/components/schemas/BlockChainEnum"},"smartContractAddress":{"type":"string","pattern":"^(0x)?[0-9a-fA-F]+$","maxLength":255},"isin":{"type":"string","pattern":"^[A-Z]{2}[0-9A-Z]{9}[0-9]$","maxLength":255},"fullName":{"type":"string","maxLength":255},"cfi":{"type":"string","pattern":"^[A-Z]{6}$","maxLength":255},"commoditiesDerivativeIndicator":{"type":"boolean","default":false},"issuerId":{"type":"string","maxLength":255},"issuerName":{"type":"string","maxLength":255},"tradingVenue":{"type":"string","maxLength":4,"default":"21XX"},"fisn":{"type":"string","maxLength":35},"issuerRequestForAdmissionToTrade":{"type":"boolean","default":false},"listingDate":{"type":"string","format":"date"},"issuerApprovalDate":{"type":"string","format":"date-time"},"admissionToTradeRequestDate":{"type":"string","format":"date-time"},"effectiveDate":{"type":"string","format":"date-time"},"terminationDate":{"type":"string","format":"date-time"},"notionalCurrency1":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255,"default":"EUR"},"mifirIdentifier":{"$ref":"#/components/schemas/MifirIdentifierEnum"},"numberOfOutstandingInstruments":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"holdingsExceedingTotalVotingRightThreshold":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"issuanceSize":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"assetClassOfUnderlying":{"$ref":"#/components/schemas/AssetClassOfUnderlyingEnum"},"maturityDate":{"type":"string","format":"date"},"contractType":{"$ref":"#/components/schemas/FinancialInstrumentContractTypeEnum"},"linkedEntities":{"type":"array","items":{"$ref":"#/components/schemas/FinancialInstrumentLinkedEntityData"}},"availability":{"$ref":"#/components/schemas/FinancialInstrumentAvailabilityData"},"displayData":{"$ref":"#/components/schemas/FinancialInstrumentDisplayData"},"performanceData":{"$ref":"#/components/schemas/FinancialInstrumentPerformanceData"},"debtInstrumentData":{"$ref":"#/components/schemas/FinancialInstrumentDebtInstrumentData"},"derivativeData":{"$ref":"#/components/schemas/FinancialInstrumentDerivativeData"},"commodityDerivativeData":{"$ref":"#/components/schemas/FinancialInstrumentCommodityDerivativeData"},"interestRateDerivativeData":{"$ref":"#/components/schemas/FinancialInstrumentInterestRateDerivativeData"},"foreignExchangeDerivativeData":{"$ref":"#/components/schemas/FinancialInstrumentForeignExchangeDerivativeData"},"emissionAllowanceData":{"$ref":"#/components/schemas/FinancialInstrumentEmissionAllowanceData"},"contractsForDifferenceData":{"$ref":"#/components/schemas/FinancialInstrumentContractsForDifferenceData"},"creditDerivativeData":{"$ref":"#/components/schemas/FinancialInstrumentCreditDerivativeData"},"internalId":{"type":"string","readOnly":true,"maxLength":255},"issuerData":{"$ref":"#/components/schemas/PublicIssuerData"}}},"FinancialInstrumentStatusEnum":{"type":"string","enum":["CREATED","APPROVED","ACTIVE","EXPIRED","DEACTIVATED"]},"BlockChainEnum":{"type":"string","enum":["POLYGON","STELLAR"]},"MifirIdentifierEnum":{"type":"string","enum":["SDRV","SFPS","BOND","ETCS","ETNS","EMAL","DERV","SHRS","ETFS","DPRS","CRFT","OTHR","NA"]},"AssetClassOfUnderlyingEnum":{"type":"string","enum":["INTR","EQUI","COMM","CRDT","CURR","EMAL","OCTN"]},"FinancialInstrumentContractTypeEnum":{"type":"string","enum":["OPTN","FUTR","FRAS","FORW","SWAP","PSWP","SWPT","OPTS","FONS","FWOS","SPDB","CFDS","OTHR"]},"FinancialInstrumentLinkedEntityData":{"required":["entityType"],"type":"object","properties":{"entityType":{"$ref":"#/components/schemas/FinancialInstrumentLinkedEntityTypeEnum"},"entityId":{"type":"string","maxLength":255},"entityName":{"type":"string","maxLength":255}}},"FinancialInstrumentLinkedEntityTypeEnum":{"type":"string","enum":["DISTRIBUTOR","FUND_ADMINISTRATOR","TOKENIZER","MARKET_MAKER","SUPERVISORY_AUTHORITY","PORTFOLIO_MANAGER","MANAGEMENT_COMPANY","INVESTMENT_MANAGER","EXECUTION_AGENT","BROKER","LISTING_SPONSOR","REGISTRAR","UNDERLYING_ISSUER"]},"FinancialInstrumentAvailabilityData":{"type":"object","properties":{"classification":{"type":"array","items":{"$ref":"#/components/schemas/FinancialInstrumentClassificationEnum"}},"distribution":{"type":"array","items":{"$ref":"#/components/schemas/FinancialInstrumentDistributionEnum"}},"jurisdictions":{"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}$","maxLength":255}}}},"FinancialInstrumentClassificationEnum":{"type":"string","enum":["RETAIL","PROFESSIONAL"]},"FinancialInstrumentDistributionEnum":{"type":"string","enum":["NATURAL_PERSON","LEGAL_ENTITY"]},"FinancialInstrumentDisplayData":{"type":"object","properties":{"assetType":{"$ref":"#/components/schemas/FinancialInstrumentAssetTypeEnum","readOnly":true},"subAssetType":{"$ref":"#/components/schemas/FinancialInstrumentAssetSubtypeEnum","readOnly":true},"prospectusLink":{"type":"string","maxLength":255},"description":{"type":"string","maxLength":2000},"replication":{"type":"string","maxLength":100},"investmentStyle":{"type":"string","maxLength":100},"useOfIncome":{"$ref":"#/components/schemas/FinancialInstrumentUseOfIncomeTypeEnum"},"instrumentName":{"type":"string","maxLength":255},"instrumentNickname":{"type":"string","maxLength":255},"underlyingInstrumentName":{"type":"string","maxLength":255},"underlyingInstrumentNickname":{"type":"string","maxLength":255},"linkToUnderlying":{"type":"string","maxLength":255}}},"FinancialInstrumentAssetTypeEnum":{"type":"string","enum":["C_COLLECTIVE_INVESTMENT_VEHICLES","D_DEBT_INSTRUMENTS","E_EQUITIES","F_FUTURES","H_NON_LISTED_COMPLEX_OPTIONS","J_FORWARDS","O_LISTED_OPTIONS","R_ENTITLEMENT","S_SWAPS","I_SPOT"]},"FinancialInstrumentAssetSubtypeEnum":{"type":"string","enum":["C_I","C_H","C_B","C_E","C_S","C_F","C_P","C_M","D_B","D_C","D_W","D_T","D_Y","D_S","D_E","D_G","D_A","D_N","D_D","D_M","E_S","E_P","E_C","E_F","E_L","E_D","E_Y","E_M","F_F","F_C","H_R","H_T","H_E","H_C","H_F","H_M","J_E","J_F","J_C","J_R","J_T","O_C","O_P","O_M","R_A","R_S","R_P","R_W","R_F","R_D","R_M","S_R","S_T","S_E","S_C","S_F","S_M","I_F","I_T"]},"FinancialInstrumentUseOfIncomeTypeEnum":{"type":"string","enum":["ACCUMULATING","DISTRIBUTING"]},"FinancialInstrumentPerformanceData":{"type":"object","properties":{"nav":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"navCurrency":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"navLastUpdate":{"type":"string","format":"date"},"navSource":{"type":"string","maxLength":255},"totalExpenseRatio":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"assetsUnderManagement":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"assetsUnderManagementCurrency":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"assetsUnderManagementLastUpdate":{"type":"string","format":"date"}}},"FinancialInstrumentDebtInstrumentData":{"type":"object","properties":{"totalIssuedNominalAmount":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"maturityDate":{"type":"string","format":"date"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"minimumTradedValue":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"fixedRate":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"bondSeniority":{"$ref":"#/components/schemas/FinancialInstrumentSeniorityEnum"},"bondType":{"$ref":"#/components/schemas/FinancialInstrumentBondTypeEnum"},"bondIssuanceDate":{"type":"string","format":"date"},"indexBenchmark":{"$ref":"#/components/schemas/FinancialInstrumentIndexBenchmarkData"}}},"FinancialInstrumentSeniorityEnum":{"type":"string","enum":["SNDB","MZZD","SBOD","JUND"]},"FinancialInstrumentBondTypeEnum":{"type":"string","enum":["EUSB","OEPB","CVTB","CVDB","CRPB","OTHR"]},"FinancialInstrumentIndexBenchmarkData":{"type":"object","properties":{"isin":{"type":"string","pattern":"^[A-Z]{2}[0-9A-Z]{9}[0-9]$","maxLength":255},"index":{"$ref":"#/components/schemas/IndexDefinitionEnum"},"indexName":{"type":"string","maxLength":25},"indexTermUnit":{"$ref":"#/components/schemas/FinancialInstrumentIndexTermUnitEnum"},"indexTermValue":{"type":"integer","format":"int32","minimum":0},"basePointSpread":{"type":"integer","format":"int32","minimum":0}}},"IndexDefinitionEnum":{"type":"string","enum":["OTHR","EONA","EONS","EURI","EUUS","EUCH","GCFR","ISDA","LIBI","LIBO","MAAA","PFAN","TIBO","STBO","BBSW","JIBA","BUBO","CDOR","CIBO","MOSP","NIBO","PRBO","TLBO","WIBO","TREA","SWAP","FUSW"]},"FinancialInstrumentIndexTermUnitEnum":{"type":"string","enum":["DAYS","WEEK","MNTH","YEAR"]},"FinancialInstrumentDerivativeData":{"type":"object","properties":{"expiryDate":{"type":"string","format":"date"},"priceMultiplier":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"optionType":{"$ref":"#/components/schemas/FinancialInstrumentOptionTypeEnum"},"strikePriceType":{"$ref":"#/components/schemas/FinancialInstrumentStrikePriceTypeEnum"},"strikePriceValue":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"strikePriceCurrency":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"optionExerciseStyle":{"$ref":"#/components/schemas/FinancialInstrumentOptionExcerciseStyleEnum"},"deliveryType":{"$ref":"#/components/schemas/FinancialInstrumentDeliveryTypeEnum"},"equityDerivativeUnderlyingType":{"$ref":"#/components/schemas/EquityDerivativeUnderlyingTypeEnum"},"equityDerivativeParameter":{"$ref":"#/components/schemas/EquityDerivativeParameterTypeEnum"},"underlyingInstruments":{"type":"array","items":{"$ref":"#/components/schemas/FinancialInstrumentUnderlyingInstrumentData"}}}},"FinancialInstrumentOptionTypeEnum":{"type":"string","enum":["PUTO","CALL","OTHR"]},"FinancialInstrumentStrikePriceTypeEnum":{"type":"string","enum":["MONE","PERC","YIEL","BIPS","PNDG"]},"FinancialInstrumentOptionExcerciseStyleEnum":{"type":"string","enum":["EURO","AMER","ASIA","BERM","OTHR"]},"FinancialInstrumentDeliveryTypeEnum":{"type":"string","enum":["PHYS","CASH","OPTL"]},"EquityDerivativeUnderlyingTypeEnum":{"type":"string","enum":["STIX","SHRS","DIVI","DVSE","BSKT","ETFS","VOLI","OTHR"]},"EquityDerivativeParameterTypeEnum":{"type":"string","enum":["PRBP","PRDV","PRVA","PRVO"]},"FinancialInstrumentUnderlyingInstrumentData":{"type":"object","properties":{"isin":{"type":"string","pattern":"^[A-Z]{2}[0-9A-Z]{9}[0-9]$","maxLength":255},"issuerLei":{"type":"string","pattern":"^[0-9A-Z]{18}[0-9]{2}$","maxLength":255},"index":{"$ref":"#/components/schemas/IndexDefinitionEnum"},"indexName":{"type":"string","maxLength":25},"indexTermUnit":{"$ref":"#/components/schemas/FinancialInstrumentIndexTermUnitEnum"},"indexTermValue":{"type":"integer","format":"int32","minimum":0}}},"FinancialInstrumentCommodityDerivativeData":{"type":"object","properties":{"baseProduct":{"$ref":"#/components/schemas/CommodityDerivativesProductEnum"},"subProduct":{"$ref":"#/components/schemas/CommodityDerivativesSubProductEnum"},"furtherSubProduct":{"$ref":"#/components/schemas/CommodityDerivativesFurtherSubProductEnum"},"transactionType":{"$ref":"#/components/schemas/CommodityDerivativeTransactionTypeEnum"},"finalPriceType":{"$ref":"#/components/schemas/CommodityDerivativeFinalPriceTypeEnum"},"sizeSpecification":{"$ref":"#/components/schemas/CommodityDerivativeSizeSpecificationEnum"},"freightRoute":{"type":"string","maxLength":6},"settlementLocation":{"type":"string","maxLength":16},"commodityNotionalCurrency":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"emissionAllowanceSubType":{"$ref":"#/components/schemas/EmissionAllowanceSubTypeEnum"}}},"CommodityDerivativesProductEnum":{"type":"string","enum":["AGRI","NRGY","ENVR","FRGT","FRTL","INDP","METL","MCEX","PAPR","POLY","INFL","OEST","OTHC","OTHR"]},"CommodityDerivativesSubProductEnum":{"type":"string","enum":["GROS","SOFT","POTA","OOLI","DIRY","FRST","SEAF","LSTK","GRIN","ELEC","NGAS","OILP","COAL","INRG","RNNG","LGHT","DIST","EMIS","WTHR","CRBR","WETF","DRYF","CSHP","AMMO","DAPH","PTSH","SLPH","UREA","UAAN","CSTR","MFTG","NPRM","PRME","CBRD","NSPT","PULP","RCVP","PLST","DLVR","NDLV"]},"CommodityDerivativesFurtherSubProductEnum":{"type":"string","enum":["FWHT","SOYB","CORN","RPSD","RICE","OTHR","CCOA","ROBU","WHSG","BRWN","LAMP","MWHT","BSLD","FITR","PKLD","OFFP","GASP","LNGG","NBPG","NCGG","TTFG","BAKK","BDSL","BRNT","BRNX","CNDA","COND","DSEL","DUBA","ESPO","ETHA","FUEL","FOIL","GOIL","GSLN","HEAT","JTFL","KERO","LLSO","MARS","NAPH","NGLO","TAPI","URAL","WTIO","CERE","ERUE","EUAE","EUAA","TNKR","DBCR","ALUM","ALUA","CBLT","COPR","IRON","LEAD","MOLY","NASC","NICK","STEL","TINN","ZINC","GOLD","SLVR","PTNM","PLDM"]},"CommodityDerivativeTransactionTypeEnum":{"type":"string","enum":["FUTR","OPTN","TAPO","SWAP","MINI","OTCT","ORIT","CRCK","DIFF","OTHR"]},"CommodityDerivativeFinalPriceTypeEnum":{"type":"string","enum":["ARGM","BLTC","EXOF","GBCL","IHSM","PLAT","OTHR"]},"CommodityDerivativeSizeSpecificationEnum":{"type":"string","enum":["CAPE","PNMX","SPMX","HAND","CLAN","DRTY"]},"EmissionAllowanceSubTypeEnum":{"type":"string","enum":["CERE","ERUE","EUAE","EUAA","OTHR"]},"FinancialInstrumentInterestRateDerivativeData":{"type":"object","properties":{"referenceRateIndex":{"$ref":"#/components/schemas/IndexDefinitionEnum"},"referenceRateName":{"type":"string","maxLength":25},"interestRateTermUnit":{"$ref":"#/components/schemas/FinancialInstrumentIndexTermUnitEnum"},"interestRateTermValue":{"type":"integer","format":"int32","minimum":0},"notionalCurrency2":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"fixedRateLeg1":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"fixedRateLeg2":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"floatingRateLeg2Index":{"$ref":"#/components/schemas/IndexDefinitionEnum"},"floatingRateLeg2Name":{"type":"string","maxLength":25},"interestRateLeg2TermUnit":{"$ref":"#/components/schemas/FinancialInstrumentIndexTermUnitEnum"},"interestRateLeg2TermValue":{"type":"integer","format":"int32","minimum":0},"underlyingInterestRateDerivativeType":{"$ref":"#/components/schemas/InterestRateDerivativeUnderlyingTypeEnum"},"underlyingInterestRateDerivativeIsin":{"type":"string","pattern":"^[A-Z]{2}[0-9A-Z]{9}[0-9]$","maxLength":255},"underlyingInterestRateDerivativeIndexName":{"type":"string","maxLength":25},"underlyingInterestRateDerivativeReferenceRateIndex":{"$ref":"#/components/schemas/IndexDefinitionEnum"},"underlyingInterestRateDerivativeReferenceRateName":{"type":"string","maxLength":25},"underlyingInterestRateDerivativeTermUnit":{"$ref":"#/components/schemas/FinancialInstrumentIndexTermUnitEnum"},"underlyingInterestRateDerivativeTermValue":{"type":"integer","format":"int32","minimum":0},"underlyingInterestRateDerivativeBond":{"$ref":"#/components/schemas/UnderlyingInterestRateDerivativeBondData"},"underlyingInterestRateDerivativeSwap":{"$ref":"#/components/schemas/UnderlyingInterestRateDerivativeSwapData"}}},"InterestRateDerivativeUnderlyingTypeEnum":{"type":"string","enum":["BOND","BNDF","INTR","IFUT","FFMC","XFMC","XXMC","OSMC","IFMC","FFSC","XFSC","XXSC","OSSC","IFSC"]},"UnderlyingInterestRateDerivativeBondData":{"type":"object","properties":{"issuerLei":{"type":"string","pattern":"^[0-9A-Z]{18}[0-9]{2}$","maxLength":255},"maturityDate":{"type":"string","format":"date"},"issuanceDate":{"type":"string","format":"date"}}},"UnderlyingInterestRateDerivativeSwapData":{"type":"object","properties":{"notionalCurrency":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"maturityDate":{"type":"string","format":"date"}}},"FinancialInstrumentForeignExchangeDerivativeData":{"type":"object","properties":{"notionalCurrency2":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"foreignExchangeType":{"$ref":"#/components/schemas/ForeignExchangeDerivativeTypeEnum"},"foreignExchangeContractSubType":{"$ref":"#/components/schemas/ForeignExchangeDerivativeContractSubTypeEnum"}}},"ForeignExchangeDerivativeTypeEnum":{"type":"string","enum":["FXCR","FXEM","FXMJ"]},"ForeignExchangeDerivativeContractSubTypeEnum":{"type":"string","enum":["DLVB","NDLV"]},"FinancialInstrumentEmissionAllowanceData":{"type":"object","properties":{"subType":{"$ref":"#/components/schemas/EmissionAllowanceSubTypeEnum"}}},"FinancialInstrumentContractsForDifferenceData":{"type":"object","properties":{"underlyingType":{"$ref":"#/components/schemas/ContractsForDifferenceUnderlyingTypeEnum"},"notionalCurrency1":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"notionalCurrency2":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255}}},"ContractsForDifferenceUnderlyingTypeEnum":{"type":"string","enum":["CURR","EQUI","BOND","FTEQ","OPEQ","COMM","EMAL","OTHR"]},"FinancialInstrumentCreditDerivativeData":{"type":"object","properties":{"underlyingSwapIsin":{"type":"string","pattern":"^[A-Z]{2}[0-9A-Z]{9}[0-9]$","maxLength":255},"underlyingIndexIsin":{"type":"string","pattern":"^[A-Z]{2}[0-9A-Z]{9}[0-9]$","maxLength":255},"underlyingIndexName":{"type":"string","maxLength":25},"series":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"version":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"rollMonths":{"type":"array","items":{"type":"string","pattern":"^((0[1-9])|(1[012]))$","maxLength":255}},"nextRollDate":{"type":"string","format":"date"},"issuerSovereignPublic":{"type":"boolean","default":false},"referenceObligationIsin":{"type":"string","pattern":"^[A-Z]{2}[0-9A-Z]{9}[0-9]$","maxLength":255},"referenceEntityCountry":{"type":"string","pattern":"^[A-Z]{2}$","maxLength":255},"referenceEntitySubDivision":{"type":"string","maxLength":6},"referenceEntityLei":{"type":"string","pattern":"^[0-9A-Z]{18}[0-9]{2}$","maxLength":255},"referenceEntityNotionalCurrency":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255}}},"PublicIssuerData":{"type":"object","properties":{"companyName":{"type":"string","maxLength":255},"website":{"type":"string","maxLength":255},"legalAddress":{"$ref":"#/components/schemas/AddressData"},"legalEntityIdentifier":{"type":"string","pattern":"^[0-9A-Z]{18}[0-9]{2}$","maxLength":255}}},"AddressData":{"required":["countryCode","areaCode","city","street"],"type":"object","properties":{"countryCode":{"type":"string","pattern":"^[A-Z]{2}$","maxLength":2},"areaCode":{"type":"string","maxLength":50},"city":{"type":"string","maxLength":50},"street":{"type":"string","maxLength":50},"postOfficeBox":{"type":"string","maxLength":50},"addressSupplement":{"type":"string","maxLength":255}}}}}} ``` ## The FinancialInstrumentTableBaseWithId object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentTableBaseWithId":{"type":"object","properties":{"symbol":{"description":"The financial instrument's symbol\n","type":"string","maxLength":255},"fullName":{"description":"The financial instrument's name\n","type":"string","maxLength":255},"status":{"description":"Trading status of the financial instrument\n","$ref":"#/components/schemas/FinancialInstrumentStatusEnum","readOnly":true},"isin":{"description":"International Securities Identification Number (ISIN) of the financial instrument\n","type":"string","pattern":"^[A-Z]{2}[0-9A-Z]{9}[0-9]$","maxLength":255},"dti":{"description":"Digital Token Identifier (DTI) of the financial instrument\n","type":"string","maxLength":255},"issuerName":{"description":"Name of the issuer of the financial instrument\n","type":"string","maxLength":255},"prospectusLink":{"description":"Link to further information about the financial instrument\n","type":"string","readOnly":true,"maxLength":255},"effectiveDate":{"description":"First day of active trading on 21X\n","type":"string","format":"date-time"},"terminationDate":{"description":"Last day of trading on 21X\n","type":"string","format":"date-time"},"smartContractAddress":{"description":"The blockchain address of the financial instrument's smart contract\n","type":"string","pattern":"^(0x)?[0-9a-fA-F]+$","maxLength":255},"internalId":{"type":"string","readOnly":true,"maxLength":255}}},"FinancialInstrumentStatusEnum":{"type":"string","enum":["CREATED","APPROVED","ACTIVE","EXPIRED","DEACTIVATED"]}}}} ``` ## The FinancialInstrumentFilterCriteria object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"FinancialInstrumentFilterCriteria":{"type":"object","properties":{"primaryMarket":{"type":"boolean"},"secondaryMarket":{"type":"boolean"}}}}}} ``` ## The GlobalTradeInfoBase object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"GlobalTradeInfoBase":{"type":"object","properties":{"lastPrice":{"description":"The price at which the last trade happened\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"referencePrice":{"description":"The reference price is set to the price at the close of the previous trading day. Used for pre-trade controls.\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"priceChange24h":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"tradeVolume24h":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"liquidityBand":{"description":"The liquidity band used to validate limit prices (tick size check)\n","type":"integer","format":"int32","minimum":0},"tradingStatus":{"description":"Status indicating if/how the trading pair can be used for trading\n","$ref":"#/components/schemas/TradingStatusEnum","readOnly":true},"statusChangeReason":{"description":"Reason why the last status change was made\n","$ref":"#/components/schemas/TradingStatusChangeReasonEnum","readOnly":true},"statusChangeReasonText":{"description":"Reason why the last status change was made (free text)\n","type":"string","readOnly":true,"maxLength":255},"tradingHaltCounter":{"description":"The number of trading halts that have occurred on the current trading day\n","type":"integer","format":"int32","minimum":0},"estimatedTradingHaltEnd":{"description":"If we are in a trading halt, the time when trading is expected to be resumed\n","type":"string","format":"date-time"}}},"TradingStatusEnum":{"type":"string","enum":["CREATED","CONTINUOUS_TRADING","OUT_OF_TRADING","AUTOMATIC_TRADING_HALT","MANUAL_TRADING_HALT","DISABLED","PERMANENTLY_DELETED"]},"TradingStatusChangeReasonEnum":{"type":"string","enum":["START_OF_TRADING_DAY","MANUAL_MARKET_OPEN","END_OF_TRADING_DAY","MANUAL_MARKET_CLOSE","REGULATOR_INITIATED_HALT","PARTICIPANT_INITIATED_HALT","VENUE_INITIATED_HALT","CAPACITY_LIMIT_HALT","VOLATILITY_HALT","TECHNICAL_HALT","TRADING_PAIR_ACTIVATION","TRADING_PAIR_DEACTIVATION","TRADING_PAIR_OFFBOARDING","TRADING_PAIR_CREATION","AUTOMATIC_RESUME"]}}}} ``` ## The PriceOhlcItem object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"PriceOhlcItem":{"type":"object","properties":{"x":{"description":"Unix Timestamp\n","type":"integer","format":"int64","minimum":0},"o":{"description":"Opening price\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"h":{"description":"Highest price\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"l":{"description":"Lowest price\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"c":{"description":"Closing price\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255}}}}}} ``` ## The TradingPairPublicExtended object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"TradingPairPublicExtended":{"required":["quoteTokenSymbol","smartContractOrderBook","smartContractBase","smartContractQuote","baseTokenNativeScale","quoteTokenNativeScale","baseTokenInternalScale","quoteTokenInternalScale","quoteTokenEquivalentCurrency"],"type":"object","properties":{"creationDate":{"type":"string","format":"date-time","readOnly":true},"modificationDate":{"type":"string","format":"date-time","readOnly":true},"quoteTokenSymbol":{"description":"The symbol of the e-money token that the financial instrument is traded in\n","type":"string","maxLength":255},"minimumSizeIncrement":{"description":"Smallest valid order size increment. All order sizes must be minimumTradeVolume + x*minimumSizeIncrement\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"priceCollarFactor":{"description":"The price collar factor is used for pre-trade controls to determine the minimum and maximum limit price allowed.\n","type":"integer","format":"int64","minimum":0},"maximumMatches":{"description":"The maximum number of standing orders in the order book that an incoming order can be matched with.\n","type":"integer","format":"int32","minimum":0},"staticThreshold":{"description":"The percentage range around the static reference price that the execution price must have (in base points)\n","type":"integer","format":"int32","minimum":0},"dynamicThreshold":{"description":"The percentage range around the dynamic reference price that the execution price must have (in base points)\n","type":"integer","format":"int32","minimum":0},"liquidityBand":{"description":"The liquidity band used for tick size checks\n","type":"integer","format":"int32","minimum":0},"blockChain":{"description":"The blockchain that the associated smart contracts run on.\n","$ref":"#/components/schemas/BlockChainEnum"},"smartContractOrderBook":{"description":"The blockchain address of the order book smart contract. Orders need to be sent to this address.\n","type":"string","pattern":"^(0x)?[0-9a-fA-F]+$","maxLength":255},"smartContractBase":{"description":"The blockchain address of the financial instrument token smart contract.\n","type":"string","pattern":"^(0x)?[0-9a-fA-F]+$","maxLength":255},"smartContractQuote":{"description":"The blockchain address of the e-money token smart contract.\n","type":"string","pattern":"^(0x)?[0-9a-fA-F]+$","maxLength":255},"makerCommission":{"description":"Maker commission in base points (10^-4)\n","type":"integer","format":"int32","minimum":0},"takerCommission":{"description":"Taker commission in base points (10^-4)\n","type":"integer","format":"int32","minimum":0},"marketMakerCommission":{"description":"Market maker commission in base points (10^-4)\n","type":"integer","format":"int32","minimum":0},"baseTokenNativeScale":{"type":"string","pattern":"^-?[0-9]{1,38}$","maxLength":255},"quoteTokenNativeScale":{"type":"string","pattern":"^-?[0-9]{1,38}$","maxLength":255},"tradingStatus":{"description":"Status indicating if/how the trading pair can be used for trading\n","$ref":"#/components/schemas/TradingStatusEnum","readOnly":true,"default":"OUT_OF_TRADING"},"orderBookVersion":{"type":"string","maxLength":255},"statusChangeReason":{"description":"Reason why the last status change was made\n","$ref":"#/components/schemas/TradingStatusChangeReasonEnum"},"statusChangeReasonText":{"description":"Reason why the last status change was made (free text)\n","type":"string","maxLength":255},"baseTokenInternalScale":{"type":"string","pattern":"^-?[0-9]{1,38}$","maxLength":255},"quoteTokenInternalScale":{"type":"string","pattern":"^-?[0-9]{1,38}$","maxLength":255},"quoteTokenEquivalentCurrency":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"staticReferencePrice":{"description":"The static reference price. Updated automatically after each trading day.\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"minimumOrderValue":{"description":"The minimum value (in quote tokens) that a valid order must have.\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"maximumOrderValue":{"description":"The maximum value (in quote tokens) that a valid order can have.\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"baseTokenData":{"$ref":"#/components/schemas/FinancialInstrumentPublic"}}},"BlockChainEnum":{"type":"string","enum":["POLYGON","STELLAR"]},"TradingStatusEnum":{"type":"string","enum":["CREATED","CONTINUOUS_TRADING","OUT_OF_TRADING","AUTOMATIC_TRADING_HALT","MANUAL_TRADING_HALT","DISABLED","PERMANENTLY_DELETED"]},"TradingStatusChangeReasonEnum":{"type":"string","enum":["START_OF_TRADING_DAY","MANUAL_MARKET_OPEN","END_OF_TRADING_DAY","MANUAL_MARKET_CLOSE","REGULATOR_INITIATED_HALT","PARTICIPANT_INITIATED_HALT","VENUE_INITIATED_HALT","CAPACITY_LIMIT_HALT","VOLATILITY_HALT","TECHNICAL_HALT","TRADING_PAIR_ACTIVATION","TRADING_PAIR_DEACTIVATION","TRADING_PAIR_OFFBOARDING","TRADING_PAIR_CREATION","AUTOMATIC_RESUME"]},"FinancialInstrumentPublic":{"required":["fullName"],"type":"object","properties":{"status":{"$ref":"#/components/schemas/FinancialInstrumentStatusEnum","readOnly":true,"default":"CREATED"},"domicile":{"type":"string","pattern":"^[A-Z]{2}$","maxLength":255},"wkn":{"type":"string","maxLength":6},"sedol":{"type":"string","maxLength":7},"cusip":{"type":"string","maxLength":9},"valor":{"type":"string","maxLength":50},"dti":{"type":"string","maxLength":9},"symbol":{"type":"string","maxLength":10},"protocol":{"$ref":"#/components/schemas/BlockChainEnum"},"smartContractAddress":{"type":"string","pattern":"^(0x)?[0-9a-fA-F]+$","maxLength":255},"isin":{"type":"string","pattern":"^[A-Z]{2}[0-9A-Z]{9}[0-9]$","maxLength":255},"fullName":{"type":"string","maxLength":255},"cfi":{"type":"string","pattern":"^[A-Z]{6}$","maxLength":255},"commoditiesDerivativeIndicator":{"type":"boolean","default":false},"issuerId":{"type":"string","maxLength":255},"issuerName":{"type":"string","maxLength":255},"tradingVenue":{"type":"string","maxLength":4,"default":"21XX"},"fisn":{"type":"string","maxLength":35},"issuerRequestForAdmissionToTrade":{"type":"boolean","default":false},"listingDate":{"type":"string","format":"date"},"issuerApprovalDate":{"type":"string","format":"date-time"},"admissionToTradeRequestDate":{"type":"string","format":"date-time"},"effectiveDate":{"type":"string","format":"date-time"},"terminationDate":{"type":"string","format":"date-time"},"notionalCurrency1":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255,"default":"EUR"},"mifirIdentifier":{"$ref":"#/components/schemas/MifirIdentifierEnum"},"numberOfOutstandingInstruments":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"holdingsExceedingTotalVotingRightThreshold":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"issuanceSize":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"assetClassOfUnderlying":{"$ref":"#/components/schemas/AssetClassOfUnderlyingEnum"},"maturityDate":{"type":"string","format":"date"},"contractType":{"$ref":"#/components/schemas/FinancialInstrumentContractTypeEnum"},"linkedEntities":{"type":"array","items":{"$ref":"#/components/schemas/FinancialInstrumentLinkedEntityData"}},"availability":{"$ref":"#/components/schemas/FinancialInstrumentAvailabilityData"},"displayData":{"$ref":"#/components/schemas/FinancialInstrumentDisplayData"},"performanceData":{"$ref":"#/components/schemas/FinancialInstrumentPerformanceData"},"debtInstrumentData":{"$ref":"#/components/schemas/FinancialInstrumentDebtInstrumentData"},"derivativeData":{"$ref":"#/components/schemas/FinancialInstrumentDerivativeData"},"commodityDerivativeData":{"$ref":"#/components/schemas/FinancialInstrumentCommodityDerivativeData"},"interestRateDerivativeData":{"$ref":"#/components/schemas/FinancialInstrumentInterestRateDerivativeData"},"foreignExchangeDerivativeData":{"$ref":"#/components/schemas/FinancialInstrumentForeignExchangeDerivativeData"},"emissionAllowanceData":{"$ref":"#/components/schemas/FinancialInstrumentEmissionAllowanceData"},"contractsForDifferenceData":{"$ref":"#/components/schemas/FinancialInstrumentContractsForDifferenceData"},"creditDerivativeData":{"$ref":"#/components/schemas/FinancialInstrumentCreditDerivativeData"},"internalId":{"type":"string","readOnly":true,"maxLength":255},"issuerData":{"$ref":"#/components/schemas/PublicIssuerData"}}},"FinancialInstrumentStatusEnum":{"type":"string","enum":["CREATED","APPROVED","ACTIVE","EXPIRED","DEACTIVATED"]},"MifirIdentifierEnum":{"type":"string","enum":["SDRV","SFPS","BOND","ETCS","ETNS","EMAL","DERV","SHRS","ETFS","DPRS","CRFT","OTHR","NA"]},"AssetClassOfUnderlyingEnum":{"type":"string","enum":["INTR","EQUI","COMM","CRDT","CURR","EMAL","OCTN"]},"FinancialInstrumentContractTypeEnum":{"type":"string","enum":["OPTN","FUTR","FRAS","FORW","SWAP","PSWP","SWPT","OPTS","FONS","FWOS","SPDB","CFDS","OTHR"]},"FinancialInstrumentLinkedEntityData":{"required":["entityType"],"type":"object","properties":{"entityType":{"$ref":"#/components/schemas/FinancialInstrumentLinkedEntityTypeEnum"},"entityId":{"type":"string","maxLength":255},"entityName":{"type":"string","maxLength":255}}},"FinancialInstrumentLinkedEntityTypeEnum":{"type":"string","enum":["DISTRIBUTOR","FUND_ADMINISTRATOR","TOKENIZER","MARKET_MAKER","SUPERVISORY_AUTHORITY","PORTFOLIO_MANAGER","MANAGEMENT_COMPANY","INVESTMENT_MANAGER","EXECUTION_AGENT","BROKER","LISTING_SPONSOR","REGISTRAR","UNDERLYING_ISSUER"]},"FinancialInstrumentAvailabilityData":{"type":"object","properties":{"classification":{"type":"array","items":{"$ref":"#/components/schemas/FinancialInstrumentClassificationEnum"}},"distribution":{"type":"array","items":{"$ref":"#/components/schemas/FinancialInstrumentDistributionEnum"}},"jurisdictions":{"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}$","maxLength":255}}}},"FinancialInstrumentClassificationEnum":{"type":"string","enum":["RETAIL","PROFESSIONAL"]},"FinancialInstrumentDistributionEnum":{"type":"string","enum":["NATURAL_PERSON","LEGAL_ENTITY"]},"FinancialInstrumentDisplayData":{"type":"object","properties":{"assetType":{"$ref":"#/components/schemas/FinancialInstrumentAssetTypeEnum","readOnly":true},"subAssetType":{"$ref":"#/components/schemas/FinancialInstrumentAssetSubtypeEnum","readOnly":true},"prospectusLink":{"type":"string","maxLength":255},"description":{"type":"string","maxLength":2000},"replication":{"type":"string","maxLength":100},"investmentStyle":{"type":"string","maxLength":100},"useOfIncome":{"$ref":"#/components/schemas/FinancialInstrumentUseOfIncomeTypeEnum"},"instrumentName":{"type":"string","maxLength":255},"instrumentNickname":{"type":"string","maxLength":255},"underlyingInstrumentName":{"type":"string","maxLength":255},"underlyingInstrumentNickname":{"type":"string","maxLength":255},"linkToUnderlying":{"type":"string","maxLength":255}}},"FinancialInstrumentAssetTypeEnum":{"type":"string","enum":["C_COLLECTIVE_INVESTMENT_VEHICLES","D_DEBT_INSTRUMENTS","E_EQUITIES","F_FUTURES","H_NON_LISTED_COMPLEX_OPTIONS","J_FORWARDS","O_LISTED_OPTIONS","R_ENTITLEMENT","S_SWAPS","I_SPOT"]},"FinancialInstrumentAssetSubtypeEnum":{"type":"string","enum":["C_I","C_H","C_B","C_E","C_S","C_F","C_P","C_M","D_B","D_C","D_W","D_T","D_Y","D_S","D_E","D_G","D_A","D_N","D_D","D_M","E_S","E_P","E_C","E_F","E_L","E_D","E_Y","E_M","F_F","F_C","H_R","H_T","H_E","H_C","H_F","H_M","J_E","J_F","J_C","J_R","J_T","O_C","O_P","O_M","R_A","R_S","R_P","R_W","R_F","R_D","R_M","S_R","S_T","S_E","S_C","S_F","S_M","I_F","I_T"]},"FinancialInstrumentUseOfIncomeTypeEnum":{"type":"string","enum":["ACCUMULATING","DISTRIBUTING"]},"FinancialInstrumentPerformanceData":{"type":"object","properties":{"nav":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"navCurrency":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"navLastUpdate":{"type":"string","format":"date"},"navSource":{"type":"string","maxLength":255},"totalExpenseRatio":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"assetsUnderManagement":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"assetsUnderManagementCurrency":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"assetsUnderManagementLastUpdate":{"type":"string","format":"date"}}},"FinancialInstrumentDebtInstrumentData":{"type":"object","properties":{"totalIssuedNominalAmount":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"maturityDate":{"type":"string","format":"date"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"minimumTradedValue":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"fixedRate":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"bondSeniority":{"$ref":"#/components/schemas/FinancialInstrumentSeniorityEnum"},"bondType":{"$ref":"#/components/schemas/FinancialInstrumentBondTypeEnum"},"bondIssuanceDate":{"type":"string","format":"date"},"indexBenchmark":{"$ref":"#/components/schemas/FinancialInstrumentIndexBenchmarkData"}}},"FinancialInstrumentSeniorityEnum":{"type":"string","enum":["SNDB","MZZD","SBOD","JUND"]},"FinancialInstrumentBondTypeEnum":{"type":"string","enum":["EUSB","OEPB","CVTB","CVDB","CRPB","OTHR"]},"FinancialInstrumentIndexBenchmarkData":{"type":"object","properties":{"isin":{"type":"string","pattern":"^[A-Z]{2}[0-9A-Z]{9}[0-9]$","maxLength":255},"index":{"$ref":"#/components/schemas/IndexDefinitionEnum"},"indexName":{"type":"string","maxLength":25},"indexTermUnit":{"$ref":"#/components/schemas/FinancialInstrumentIndexTermUnitEnum"},"indexTermValue":{"type":"integer","format":"int32","minimum":0},"basePointSpread":{"type":"integer","format":"int32","minimum":0}}},"IndexDefinitionEnum":{"type":"string","enum":["OTHR","EONA","EONS","EURI","EUUS","EUCH","GCFR","ISDA","LIBI","LIBO","MAAA","PFAN","TIBO","STBO","BBSW","JIBA","BUBO","CDOR","CIBO","MOSP","NIBO","PRBO","TLBO","WIBO","TREA","SWAP","FUSW"]},"FinancialInstrumentIndexTermUnitEnum":{"type":"string","enum":["DAYS","WEEK","MNTH","YEAR"]},"FinancialInstrumentDerivativeData":{"type":"object","properties":{"expiryDate":{"type":"string","format":"date"},"priceMultiplier":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"optionType":{"$ref":"#/components/schemas/FinancialInstrumentOptionTypeEnum"},"strikePriceType":{"$ref":"#/components/schemas/FinancialInstrumentStrikePriceTypeEnum"},"strikePriceValue":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"strikePriceCurrency":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"optionExerciseStyle":{"$ref":"#/components/schemas/FinancialInstrumentOptionExcerciseStyleEnum"},"deliveryType":{"$ref":"#/components/schemas/FinancialInstrumentDeliveryTypeEnum"},"equityDerivativeUnderlyingType":{"$ref":"#/components/schemas/EquityDerivativeUnderlyingTypeEnum"},"equityDerivativeParameter":{"$ref":"#/components/schemas/EquityDerivativeParameterTypeEnum"},"underlyingInstruments":{"type":"array","items":{"$ref":"#/components/schemas/FinancialInstrumentUnderlyingInstrumentData"}}}},"FinancialInstrumentOptionTypeEnum":{"type":"string","enum":["PUTO","CALL","OTHR"]},"FinancialInstrumentStrikePriceTypeEnum":{"type":"string","enum":["MONE","PERC","YIEL","BIPS","PNDG"]},"FinancialInstrumentOptionExcerciseStyleEnum":{"type":"string","enum":["EURO","AMER","ASIA","BERM","OTHR"]},"FinancialInstrumentDeliveryTypeEnum":{"type":"string","enum":["PHYS","CASH","OPTL"]},"EquityDerivativeUnderlyingTypeEnum":{"type":"string","enum":["STIX","SHRS","DIVI","DVSE","BSKT","ETFS","VOLI","OTHR"]},"EquityDerivativeParameterTypeEnum":{"type":"string","enum":["PRBP","PRDV","PRVA","PRVO"]},"FinancialInstrumentUnderlyingInstrumentData":{"type":"object","properties":{"isin":{"type":"string","pattern":"^[A-Z]{2}[0-9A-Z]{9}[0-9]$","maxLength":255},"issuerLei":{"type":"string","pattern":"^[0-9A-Z]{18}[0-9]{2}$","maxLength":255},"index":{"$ref":"#/components/schemas/IndexDefinitionEnum"},"indexName":{"type":"string","maxLength":25},"indexTermUnit":{"$ref":"#/components/schemas/FinancialInstrumentIndexTermUnitEnum"},"indexTermValue":{"type":"integer","format":"int32","minimum":0}}},"FinancialInstrumentCommodityDerivativeData":{"type":"object","properties":{"baseProduct":{"$ref":"#/components/schemas/CommodityDerivativesProductEnum"},"subProduct":{"$ref":"#/components/schemas/CommodityDerivativesSubProductEnum"},"furtherSubProduct":{"$ref":"#/components/schemas/CommodityDerivativesFurtherSubProductEnum"},"transactionType":{"$ref":"#/components/schemas/CommodityDerivativeTransactionTypeEnum"},"finalPriceType":{"$ref":"#/components/schemas/CommodityDerivativeFinalPriceTypeEnum"},"sizeSpecification":{"$ref":"#/components/schemas/CommodityDerivativeSizeSpecificationEnum"},"freightRoute":{"type":"string","maxLength":6},"settlementLocation":{"type":"string","maxLength":16},"commodityNotionalCurrency":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"emissionAllowanceSubType":{"$ref":"#/components/schemas/EmissionAllowanceSubTypeEnum"}}},"CommodityDerivativesProductEnum":{"type":"string","enum":["AGRI","NRGY","ENVR","FRGT","FRTL","INDP","METL","MCEX","PAPR","POLY","INFL","OEST","OTHC","OTHR"]},"CommodityDerivativesSubProductEnum":{"type":"string","enum":["GROS","SOFT","POTA","OOLI","DIRY","FRST","SEAF","LSTK","GRIN","ELEC","NGAS","OILP","COAL","INRG","RNNG","LGHT","DIST","EMIS","WTHR","CRBR","WETF","DRYF","CSHP","AMMO","DAPH","PTSH","SLPH","UREA","UAAN","CSTR","MFTG","NPRM","PRME","CBRD","NSPT","PULP","RCVP","PLST","DLVR","NDLV"]},"CommodityDerivativesFurtherSubProductEnum":{"type":"string","enum":["FWHT","SOYB","CORN","RPSD","RICE","OTHR","CCOA","ROBU","WHSG","BRWN","LAMP","MWHT","BSLD","FITR","PKLD","OFFP","GASP","LNGG","NBPG","NCGG","TTFG","BAKK","BDSL","BRNT","BRNX","CNDA","COND","DSEL","DUBA","ESPO","ETHA","FUEL","FOIL","GOIL","GSLN","HEAT","JTFL","KERO","LLSO","MARS","NAPH","NGLO","TAPI","URAL","WTIO","CERE","ERUE","EUAE","EUAA","TNKR","DBCR","ALUM","ALUA","CBLT","COPR","IRON","LEAD","MOLY","NASC","NICK","STEL","TINN","ZINC","GOLD","SLVR","PTNM","PLDM"]},"CommodityDerivativeTransactionTypeEnum":{"type":"string","enum":["FUTR","OPTN","TAPO","SWAP","MINI","OTCT","ORIT","CRCK","DIFF","OTHR"]},"CommodityDerivativeFinalPriceTypeEnum":{"type":"string","enum":["ARGM","BLTC","EXOF","GBCL","IHSM","PLAT","OTHR"]},"CommodityDerivativeSizeSpecificationEnum":{"type":"string","enum":["CAPE","PNMX","SPMX","HAND","CLAN","DRTY"]},"EmissionAllowanceSubTypeEnum":{"type":"string","enum":["CERE","ERUE","EUAE","EUAA","OTHR"]},"FinancialInstrumentInterestRateDerivativeData":{"type":"object","properties":{"referenceRateIndex":{"$ref":"#/components/schemas/IndexDefinitionEnum"},"referenceRateName":{"type":"string","maxLength":25},"interestRateTermUnit":{"$ref":"#/components/schemas/FinancialInstrumentIndexTermUnitEnum"},"interestRateTermValue":{"type":"integer","format":"int32","minimum":0},"notionalCurrency2":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"fixedRateLeg1":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"fixedRateLeg2":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"floatingRateLeg2Index":{"$ref":"#/components/schemas/IndexDefinitionEnum"},"floatingRateLeg2Name":{"type":"string","maxLength":25},"interestRateLeg2TermUnit":{"$ref":"#/components/schemas/FinancialInstrumentIndexTermUnitEnum"},"interestRateLeg2TermValue":{"type":"integer","format":"int32","minimum":0},"underlyingInterestRateDerivativeType":{"$ref":"#/components/schemas/InterestRateDerivativeUnderlyingTypeEnum"},"underlyingInterestRateDerivativeIsin":{"type":"string","pattern":"^[A-Z]{2}[0-9A-Z]{9}[0-9]$","maxLength":255},"underlyingInterestRateDerivativeIndexName":{"type":"string","maxLength":25},"underlyingInterestRateDerivativeReferenceRateIndex":{"$ref":"#/components/schemas/IndexDefinitionEnum"},"underlyingInterestRateDerivativeReferenceRateName":{"type":"string","maxLength":25},"underlyingInterestRateDerivativeTermUnit":{"$ref":"#/components/schemas/FinancialInstrumentIndexTermUnitEnum"},"underlyingInterestRateDerivativeTermValue":{"type":"integer","format":"int32","minimum":0},"underlyingInterestRateDerivativeBond":{"$ref":"#/components/schemas/UnderlyingInterestRateDerivativeBondData"},"underlyingInterestRateDerivativeSwap":{"$ref":"#/components/schemas/UnderlyingInterestRateDerivativeSwapData"}}},"InterestRateDerivativeUnderlyingTypeEnum":{"type":"string","enum":["BOND","BNDF","INTR","IFUT","FFMC","XFMC","XXMC","OSMC","IFMC","FFSC","XFSC","XXSC","OSSC","IFSC"]},"UnderlyingInterestRateDerivativeBondData":{"type":"object","properties":{"issuerLei":{"type":"string","pattern":"^[0-9A-Z]{18}[0-9]{2}$","maxLength":255},"maturityDate":{"type":"string","format":"date"},"issuanceDate":{"type":"string","format":"date"}}},"UnderlyingInterestRateDerivativeSwapData":{"type":"object","properties":{"notionalCurrency":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"maturityDate":{"type":"string","format":"date"}}},"FinancialInstrumentForeignExchangeDerivativeData":{"type":"object","properties":{"notionalCurrency2":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"foreignExchangeType":{"$ref":"#/components/schemas/ForeignExchangeDerivativeTypeEnum"},"foreignExchangeContractSubType":{"$ref":"#/components/schemas/ForeignExchangeDerivativeContractSubTypeEnum"}}},"ForeignExchangeDerivativeTypeEnum":{"type":"string","enum":["FXCR","FXEM","FXMJ"]},"ForeignExchangeDerivativeContractSubTypeEnum":{"type":"string","enum":["DLVB","NDLV"]},"FinancialInstrumentEmissionAllowanceData":{"type":"object","properties":{"subType":{"$ref":"#/components/schemas/EmissionAllowanceSubTypeEnum"}}},"FinancialInstrumentContractsForDifferenceData":{"type":"object","properties":{"underlyingType":{"$ref":"#/components/schemas/ContractsForDifferenceUnderlyingTypeEnum"},"notionalCurrency1":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"notionalCurrency2":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255}}},"ContractsForDifferenceUnderlyingTypeEnum":{"type":"string","enum":["CURR","EQUI","BOND","FTEQ","OPEQ","COMM","EMAL","OTHR"]},"FinancialInstrumentCreditDerivativeData":{"type":"object","properties":{"underlyingSwapIsin":{"type":"string","pattern":"^[A-Z]{2}[0-9A-Z]{9}[0-9]$","maxLength":255},"underlyingIndexIsin":{"type":"string","pattern":"^[A-Z]{2}[0-9A-Z]{9}[0-9]$","maxLength":255},"underlyingIndexName":{"type":"string","maxLength":25},"series":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"version":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"rollMonths":{"type":"array","items":{"type":"string","pattern":"^((0[1-9])|(1[012]))$","maxLength":255}},"nextRollDate":{"type":"string","format":"date"},"issuerSovereignPublic":{"type":"boolean","default":false},"referenceObligationIsin":{"type":"string","pattern":"^[A-Z]{2}[0-9A-Z]{9}[0-9]$","maxLength":255},"referenceEntityCountry":{"type":"string","pattern":"^[A-Z]{2}$","maxLength":255},"referenceEntitySubDivision":{"type":"string","maxLength":6},"referenceEntityLei":{"type":"string","pattern":"^[0-9A-Z]{18}[0-9]{2}$","maxLength":255},"referenceEntityNotionalCurrency":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255}}},"PublicIssuerData":{"type":"object","properties":{"companyName":{"type":"string","maxLength":255},"website":{"type":"string","maxLength":255},"legalAddress":{"$ref":"#/components/schemas/AddressData"},"legalEntityIdentifier":{"type":"string","pattern":"^[0-9A-Z]{18}[0-9]{2}$","maxLength":255}}},"AddressData":{"required":["countryCode","areaCode","city","street"],"type":"object","properties":{"countryCode":{"type":"string","pattern":"^[A-Z]{2}$","maxLength":2},"areaCode":{"type":"string","maxLength":50},"city":{"type":"string","maxLength":50},"street":{"type":"string","maxLength":50},"postOfficeBox":{"type":"string","maxLength":50},"addressSupplement":{"type":"string","maxLength":255}}}}}} ``` ## The OrderBookItemReduced object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"OrderBookItemReduced":{"required":["orderType","quantity"],"type":"object","properties":{"orderType":{"description":"The type of the order (currently only limit orders)\n","$ref":"#/components/schemas/OrderTypeEnum"},"quantity":{"description":"Remaining order size in financial instrument (base) tokens\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"limit":{"description":"The price limit of the order. Mandatory for limit orders\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255}}},"OrderTypeEnum":{"type":"string","enum":["LIMIT","MARKET"]}}}} ``` ## The OrderBookPriceLevelItem object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"OrderBookPriceLevelItem":{"required":["orderCount","totalQuantity"],"type":"object","properties":{"limit":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"orderCount":{"type":"integer","format":"int32","minimum":0},"totalQuantity":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255}}}}}} ``` ## The OrderBookPriceLevelResult object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"OrderBookPriceLevelResult":{"required":["tradingPairId"],"type":"object","properties":{"tradingPairId":{"type":"string","maxLength":255},"buy":{"type":"array","items":{"$ref":"#/components/schemas/OrderBookPriceLevelItem"}},"sell":{"type":"array","items":{"$ref":"#/components/schemas/OrderBookPriceLevelItem"}}}},"OrderBookPriceLevelItem":{"required":["orderCount","totalQuantity"],"type":"object","properties":{"limit":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"orderCount":{"type":"integer","format":"int32","minimum":0},"totalQuantity":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255}}}}}} ``` ## The OrderBookResult object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"OrderBookResult":{"required":["tradingPairId"],"type":"object","properties":{"tradingPairId":{"type":"string","maxLength":255},"buy":{"type":"array","items":{"$ref":"#/components/schemas/OrderBookItemReduced"}},"sell":{"type":"array","items":{"$ref":"#/components/schemas/OrderBookItemReduced"}}}},"OrderBookItemReduced":{"required":["orderType","quantity"],"type":"object","properties":{"orderType":{"description":"The type of the order (currently only limit orders)\n","$ref":"#/components/schemas/OrderTypeEnum"},"quantity":{"description":"Remaining order size in financial instrument (base) tokens\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"limit":{"description":"The price limit of the order. Mandatory for limit orders\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255}}},"OrderTypeEnum":{"type":"string","enum":["LIMIT","MARKET"]}}}} ``` ## The PrimaryMarketOrderData object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"PrimaryMarketOrderData":{"required":["orderKind","financialInstrumentId","quantity","quantityType","timestamp"],"type":"object","properties":{"orderKind":{"description":"The kind of the order (buy/sell)\n","$ref":"#/components/schemas/OrderKindEnum"},"financialInstrumentId":{"description":"The ID of the financial instrument that shall be traded\n","type":"string","maxLength":255},"quantity":{"description":"The number of financial instrument tokens that shall be traded\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"quantityType":{"description":"Specifies if the quantity is expressed in units or monetary amount\n","$ref":"#/components/schemas/OrderQuantityTypeEnum"},"priceLimit":{"description":"The price limit is optional since it is only applicable in some cases\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"settlementCurrency":{"description":"The currency used for the price limit, and in which the trade should be settled\n","type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"timestamp":{"description":"Time of order creation (in UTC time zone)\n","type":"string","maxLength":255},"additionalData":{"description":"Arbitrary additional data to be added to the order information\n","type":"object"}}},"OrderKindEnum":{"type":"string","enum":["BUY","SELL"]},"OrderQuantityTypeEnum":{"type":"string","enum":["UNIT","MONEY"]}}}} ``` ## The SignedPrimaryMarketOrderPayload object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"SignedPrimaryMarketOrderPayload":{"required":["payload","signature"],"type":"object","properties":{"payload":{"description":"The primary market order data\n","$ref":"#/components/schemas/PrimaryMarketOrderData"},"signature":{"description":"Digital signature of the payload data, created by the sending wallet\n","type":"string","maxLength":255}}},"PrimaryMarketOrderData":{"required":["orderKind","financialInstrumentId","quantity","quantityType","timestamp"],"type":"object","properties":{"orderKind":{"description":"The kind of the order (buy/sell)\n","$ref":"#/components/schemas/OrderKindEnum"},"financialInstrumentId":{"description":"The ID of the financial instrument that shall be traded\n","type":"string","maxLength":255},"quantity":{"description":"The number of financial instrument tokens that shall be traded\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"quantityType":{"description":"Specifies if the quantity is expressed in units or monetary amount\n","$ref":"#/components/schemas/OrderQuantityTypeEnum"},"priceLimit":{"description":"The price limit is optional since it is only applicable in some cases\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"settlementCurrency":{"description":"The currency used for the price limit, and in which the trade should be settled\n","type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"timestamp":{"description":"Time of order creation (in UTC time zone)\n","type":"string","maxLength":255},"additionalData":{"description":"Arbitrary additional data to be added to the order information\n","type":"object"}}},"OrderKindEnum":{"type":"string","enum":["BUY","SELL"]},"OrderQuantityTypeEnum":{"type":"string","enum":["UNIT","MONEY"]}}}} ``` ## The WalletReduced object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"WalletReduced":{"type":"object","properties":{"address":{"description":"The blockchain address of the wallet\n","type":"string","pattern":"^(0x)?[0-9a-fA-F]+$","maxLength":255},"status":{"description":"Status of the wallet\n","$ref":"#/components/schemas/WalletStatusEnum"},"designation":{"description":"Designated usage of the wallet\n","$ref":"#/components/schemas/WalletDesignationEnum"}}},"WalletStatusEnum":{"type":"string","enum":["CREATED","IN_VERIFICATION","VERIFIED","REMOVED","BLOCKED"]},"WalletDesignationEnum":{"type":"string","enum":["TRADING","MARKET_MAKER"]}}}} ``` ## The PostTradeTransparencyDataList object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"PostTradeTransparencyDataList":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PostTradeTransparencyData"}},"next_cursor":{"type":"string","maxLength":255},"total_count":{"type":"integer","format":"int64","minimum":0}}},"PostTradeTransparencyData":{"required":["tradingDateTime","instrumentIdentificationCodeType","instrumentIdentificationCode","price","priceCurrency","priceNotation","quantity","venueOfExecution","publicationDateTime","transactionIdentificationCode","notionalAmount"],"type":"object","properties":{"tradingDateTime":{"description":"Date and time of the finality of the transaction\n","type":"string","format":"date-time"},"instrumentIdentificationCodeType":{"description":"The type of the instrument identification code, e.g. 'ISIN'\n","type":"string","maxLength":255},"instrumentIdentificationCode":{"description":"The identification code of the financial instrument\n","type":"string","maxLength":255},"price":{"description":"The price at which the transaction was executed\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"priceCurrency":{"description":"Short code of the currency that the price is listed in\n","type":"string","maxLength":255},"priceNotation":{"description":"Usually 'MONE' for monetary value\n","type":"string","maxLength":255},"quantity":{"description":"The number of units of the financial instrument that were traded\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"venueOfExecution":{"description":"MIC of the trading venue, e.g. '21XX'\n","type":"string","maxLength":255},"publicationDateTime":{"description":"Date and time that the transaction was published\n","type":"string","format":"date-time"},"transactionIdentificationCode":{"description":"Alpha-numeric string uniquely identifying each transaction\n","type":"string","maxLength":255},"notionalAmount":{"description":"The total monetary value of the transaction (price*quantity)\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"notionalCurrency":{"description":"Short code of the currency that the notional amount is listed in\n","type":"string","maxLength":255}}}}}} ``` ## The PostTradeTransparencyData object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"PostTradeTransparencyData":{"required":["tradingDateTime","instrumentIdentificationCodeType","instrumentIdentificationCode","price","priceCurrency","priceNotation","quantity","venueOfExecution","publicationDateTime","transactionIdentificationCode","notionalAmount"],"type":"object","properties":{"tradingDateTime":{"description":"Date and time of the finality of the transaction\n","type":"string","format":"date-time"},"instrumentIdentificationCodeType":{"description":"The type of the instrument identification code, e.g. 'ISIN'\n","type":"string","maxLength":255},"instrumentIdentificationCode":{"description":"The identification code of the financial instrument\n","type":"string","maxLength":255},"price":{"description":"The price at which the transaction was executed\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"priceCurrency":{"description":"Short code of the currency that the price is listed in\n","type":"string","maxLength":255},"priceNotation":{"description":"Usually 'MONE' for monetary value\n","type":"string","maxLength":255},"quantity":{"description":"The number of units of the financial instrument that were traded\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"venueOfExecution":{"description":"MIC of the trading venue, e.g. '21XX'\n","type":"string","maxLength":255},"publicationDateTime":{"description":"Date and time that the transaction was published\n","type":"string","format":"date-time"},"transactionIdentificationCode":{"description":"Alpha-numeric string uniquely identifying each transaction\n","type":"string","maxLength":255},"notionalAmount":{"description":"The total monetary value of the transaction (price*quantity)\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"notionalCurrency":{"description":"Short code of the currency that the notional amount is listed in\n","type":"string","maxLength":255}}}}}} ``` ## The WebSocketTickerDataItem object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"WebSocketTickerDataItem":{"type":"object","properties":{"symbol":{"type":"string","maxLength":255},"lastPrice":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"bestBuyLimit":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"bestBuyQuantity":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"bestSellLimit":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"bestSellQuantity":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"time":{"type":"string","format":"date-time"}}}}}} ``` ## The WebSocketTickerFull object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"WebSocketTickerFull":{"type":"object","properties":{"channel":{"type":"string","maxLength":255},"type":{"type":"string","maxLength":255},"data":{"type":"array","items":{"$ref":"#/components/schemas/WebSocketTickerDataItem"}}}},"WebSocketTickerDataItem":{"type":"object","properties":{"symbol":{"type":"string","maxLength":255},"lastPrice":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"bestBuyLimit":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"bestBuyQuantity":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"bestSellLimit":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"bestSellQuantity":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"time":{"type":"string","format":"date-time"}}}}}} ``` ## The WebSocketOrderBookDataItem object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"WebSocketOrderBookDataItem":{"type":"object","properties":{"symbol":{"type":"string","maxLength":255},"time":{"type":"string","format":"date-time"},"buy":{"type":"array","items":{"$ref":"#/components/schemas/OrderBookPriceLevelItem"}},"sell":{"type":"array","items":{"$ref":"#/components/schemas/OrderBookPriceLevelItem"}}}},"OrderBookPriceLevelItem":{"required":["orderCount","totalQuantity"],"type":"object","properties":{"limit":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"orderCount":{"type":"integer","format":"int32","minimum":0},"totalQuantity":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255}}}}}} ``` ## The WebSocketOrderBookFull object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"WebSocketOrderBookFull":{"type":"object","properties":{"channel":{"type":"string","maxLength":255},"type":{"type":"string","maxLength":255},"data":{"type":"array","items":{"$ref":"#/components/schemas/WebSocketOrderBookDataItem"}}}},"WebSocketOrderBookDataItem":{"type":"object","properties":{"symbol":{"type":"string","maxLength":255},"time":{"type":"string","format":"date-time"},"buy":{"type":"array","items":{"$ref":"#/components/schemas/OrderBookPriceLevelItem"}},"sell":{"type":"array","items":{"$ref":"#/components/schemas/OrderBookPriceLevelItem"}}}},"OrderBookPriceLevelItem":{"required":["orderCount","totalQuantity"],"type":"object","properties":{"limit":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"orderCount":{"type":"integer","format":"int32","minimum":0},"totalQuantity":{"type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255}}}}}} ``` ## The TradingPairList object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"TradingPairList":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/TradingPair"}},"next_cursor":{"type":"string","maxLength":255},"total_count":{"type":"integer","format":"int64","minimum":0}}},"TradingPair":{"required":["id","quoteTokenSymbol","smartContractOrderBook","smartContractBase","smartContractQuote","baseTokenNativeScale","quoteTokenNativeScale","baseTokenInternalScale","quoteTokenInternalScale","quoteTokenEquivalentCurrency"],"type":"object","properties":{"id":{"type":"string","readOnly":true,"maxLength":255},"creationDate":{"type":"string","format":"date-time","readOnly":true},"modificationDate":{"type":"string","format":"date-time","readOnly":true},"quoteTokenSymbol":{"description":"The symbol of the e-money token that the financial instrument is traded in\n","type":"string","maxLength":255},"minimumSizeIncrement":{"description":"Smallest valid order size increment. All order sizes must be minimumTradeVolume + x*minimumSizeIncrement\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"priceCollarFactor":{"description":"The price collar factor is used for pre-trade controls to determine the minimum and maximum limit price allowed.\n","type":"integer","format":"int64","minimum":0},"maximumMatches":{"description":"The maximum number of standing orders in the order book that an incoming order can be matched with.\n","type":"integer","format":"int32","minimum":0},"staticThreshold":{"description":"The percentage range around the static reference price that the execution price must have (in base points)\n","type":"integer","format":"int32","minimum":0},"dynamicThreshold":{"description":"The percentage range around the dynamic reference price that the execution price must have (in base points)\n","type":"integer","format":"int32","minimum":0},"liquidityBand":{"description":"The liquidity band used for tick size checks\n","type":"integer","format":"int32","minimum":0},"blockChain":{"description":"The blockchain that the associated smart contracts run on.\n","$ref":"#/components/schemas/BlockChainEnum"},"smartContractOrderBook":{"description":"The blockchain address of the order book smart contract. Orders need to be sent to this address.\n","type":"string","pattern":"^(0x)?[0-9a-fA-F]+$","maxLength":255},"smartContractBase":{"description":"The blockchain address of the financial instrument token smart contract.\n","type":"string","pattern":"^(0x)?[0-9a-fA-F]+$","maxLength":255},"smartContractQuote":{"description":"The blockchain address of the e-money token smart contract.\n","type":"string","pattern":"^(0x)?[0-9a-fA-F]+$","maxLength":255},"makerCommission":{"description":"Maker commission in base points (10^-4)\n","type":"integer","format":"int32","minimum":0},"takerCommission":{"description":"Taker commission in base points (10^-4)\n","type":"integer","format":"int32","minimum":0},"marketMakerCommission":{"description":"Market maker commission in base points (10^-4)\n","type":"integer","format":"int32","minimum":0},"baseTokenNativeScale":{"type":"string","pattern":"^-?[0-9]{1,38}$","maxLength":255},"quoteTokenNativeScale":{"type":"string","pattern":"^-?[0-9]{1,38}$","maxLength":255},"tradingStatus":{"description":"Status indicating if/how the trading pair can be used for trading\n","$ref":"#/components/schemas/TradingStatusEnum","readOnly":true,"default":"OUT_OF_TRADING"},"orderBookVersion":{"type":"string","maxLength":255},"statusChangeReason":{"description":"Reason why the last status change was made\n","$ref":"#/components/schemas/TradingStatusChangeReasonEnum"},"statusChangeReasonText":{"description":"Reason why the last status change was made (free text)\n","type":"string","maxLength":255},"baseTokenInternalScale":{"type":"string","pattern":"^-?[0-9]{1,38}$","maxLength":255},"quoteTokenInternalScale":{"type":"string","pattern":"^-?[0-9]{1,38}$","maxLength":255},"quoteTokenEquivalentCurrency":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"staticReferencePrice":{"description":"The static reference price. Updated automatically after each trading day.\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"minimumOrderValue":{"description":"The minimum value (in quote tokens) that a valid order must have.\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"maximumOrderValue":{"description":"The maximum value (in quote tokens) that a valid order can have.\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"baseTokenData":{"$ref":"#/components/schemas/FinancialInstrumentTableBase"}}},"BlockChainEnum":{"type":"string","enum":["POLYGON","STELLAR"]},"TradingStatusEnum":{"type":"string","enum":["CREATED","CONTINUOUS_TRADING","OUT_OF_TRADING","AUTOMATIC_TRADING_HALT","MANUAL_TRADING_HALT","DISABLED","PERMANENTLY_DELETED"]},"TradingStatusChangeReasonEnum":{"type":"string","enum":["START_OF_TRADING_DAY","MANUAL_MARKET_OPEN","END_OF_TRADING_DAY","MANUAL_MARKET_CLOSE","REGULATOR_INITIATED_HALT","PARTICIPANT_INITIATED_HALT","VENUE_INITIATED_HALT","CAPACITY_LIMIT_HALT","VOLATILITY_HALT","TECHNICAL_HALT","TRADING_PAIR_ACTIVATION","TRADING_PAIR_DEACTIVATION","TRADING_PAIR_OFFBOARDING","TRADING_PAIR_CREATION","AUTOMATIC_RESUME"]},"FinancialInstrumentTableBase":{"type":"object","properties":{"symbol":{"description":"The financial instrument's symbol\n","type":"string","maxLength":255},"fullName":{"description":"The financial instrument's name\n","type":"string","maxLength":255},"status":{"description":"Trading status of the financial instrument\n","$ref":"#/components/schemas/FinancialInstrumentStatusEnum","readOnly":true},"isin":{"description":"International Securities Identification Number (ISIN) of the financial instrument\n","type":"string","pattern":"^[A-Z]{2}[0-9A-Z]{9}[0-9]$","maxLength":255},"dti":{"description":"Digital Token Identifier (DTI) of the financial instrument\n","type":"string","maxLength":255},"issuerName":{"description":"Name of the issuer of the financial instrument\n","type":"string","maxLength":255},"prospectusLink":{"description":"Link to further information about the financial instrument\n","type":"string","readOnly":true,"maxLength":255},"effectiveDate":{"description":"First day of active trading on 21X\n","type":"string","format":"date-time"},"terminationDate":{"description":"Last day of trading on 21X\n","type":"string","format":"date-time"},"smartContractAddress":{"description":"The blockchain address of the financial instrument's smart contract\n","type":"string","pattern":"^(0x)?[0-9a-fA-F]+$","maxLength":255}}},"FinancialInstrumentStatusEnum":{"type":"string","enum":["CREATED","APPROVED","ACTIVE","EXPIRED","DEACTIVATED"]}}}} ``` ## The TradingPair object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"TradingPair":{"required":["id","quoteTokenSymbol","smartContractOrderBook","smartContractBase","smartContractQuote","baseTokenNativeScale","quoteTokenNativeScale","baseTokenInternalScale","quoteTokenInternalScale","quoteTokenEquivalentCurrency"],"type":"object","properties":{"id":{"type":"string","readOnly":true,"maxLength":255},"creationDate":{"type":"string","format":"date-time","readOnly":true},"modificationDate":{"type":"string","format":"date-time","readOnly":true},"quoteTokenSymbol":{"description":"The symbol of the e-money token that the financial instrument is traded in\n","type":"string","maxLength":255},"minimumSizeIncrement":{"description":"Smallest valid order size increment. All order sizes must be minimumTradeVolume + x*minimumSizeIncrement\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"priceCollarFactor":{"description":"The price collar factor is used for pre-trade controls to determine the minimum and maximum limit price allowed.\n","type":"integer","format":"int64","minimum":0},"maximumMatches":{"description":"The maximum number of standing orders in the order book that an incoming order can be matched with.\n","type":"integer","format":"int32","minimum":0},"staticThreshold":{"description":"The percentage range around the static reference price that the execution price must have (in base points)\n","type":"integer","format":"int32","minimum":0},"dynamicThreshold":{"description":"The percentage range around the dynamic reference price that the execution price must have (in base points)\n","type":"integer","format":"int32","minimum":0},"liquidityBand":{"description":"The liquidity band used for tick size checks\n","type":"integer","format":"int32","minimum":0},"blockChain":{"description":"The blockchain that the associated smart contracts run on.\n","$ref":"#/components/schemas/BlockChainEnum"},"smartContractOrderBook":{"description":"The blockchain address of the order book smart contract. Orders need to be sent to this address.\n","type":"string","pattern":"^(0x)?[0-9a-fA-F]+$","maxLength":255},"smartContractBase":{"description":"The blockchain address of the financial instrument token smart contract.\n","type":"string","pattern":"^(0x)?[0-9a-fA-F]+$","maxLength":255},"smartContractQuote":{"description":"The blockchain address of the e-money token smart contract.\n","type":"string","pattern":"^(0x)?[0-9a-fA-F]+$","maxLength":255},"makerCommission":{"description":"Maker commission in base points (10^-4)\n","type":"integer","format":"int32","minimum":0},"takerCommission":{"description":"Taker commission in base points (10^-4)\n","type":"integer","format":"int32","minimum":0},"marketMakerCommission":{"description":"Market maker commission in base points (10^-4)\n","type":"integer","format":"int32","minimum":0},"baseTokenNativeScale":{"type":"string","pattern":"^-?[0-9]{1,38}$","maxLength":255},"quoteTokenNativeScale":{"type":"string","pattern":"^-?[0-9]{1,38}$","maxLength":255},"tradingStatus":{"description":"Status indicating if/how the trading pair can be used for trading\n","$ref":"#/components/schemas/TradingStatusEnum","readOnly":true,"default":"OUT_OF_TRADING"},"orderBookVersion":{"type":"string","maxLength":255},"statusChangeReason":{"description":"Reason why the last status change was made\n","$ref":"#/components/schemas/TradingStatusChangeReasonEnum"},"statusChangeReasonText":{"description":"Reason why the last status change was made (free text)\n","type":"string","maxLength":255},"baseTokenInternalScale":{"type":"string","pattern":"^-?[0-9]{1,38}$","maxLength":255},"quoteTokenInternalScale":{"type":"string","pattern":"^-?[0-9]{1,38}$","maxLength":255},"quoteTokenEquivalentCurrency":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":255},"staticReferencePrice":{"description":"The static reference price. Updated automatically after each trading day.\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"minimumOrderValue":{"description":"The minimum value (in quote tokens) that a valid order must have.\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"maximumOrderValue":{"description":"The maximum value (in quote tokens) that a valid order can have.\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"baseTokenData":{"$ref":"#/components/schemas/FinancialInstrumentTableBase"}}},"BlockChainEnum":{"type":"string","enum":["POLYGON","STELLAR"]},"TradingStatusEnum":{"type":"string","enum":["CREATED","CONTINUOUS_TRADING","OUT_OF_TRADING","AUTOMATIC_TRADING_HALT","MANUAL_TRADING_HALT","DISABLED","PERMANENTLY_DELETED"]},"TradingStatusChangeReasonEnum":{"type":"string","enum":["START_OF_TRADING_DAY","MANUAL_MARKET_OPEN","END_OF_TRADING_DAY","MANUAL_MARKET_CLOSE","REGULATOR_INITIATED_HALT","PARTICIPANT_INITIATED_HALT","VENUE_INITIATED_HALT","CAPACITY_LIMIT_HALT","VOLATILITY_HALT","TECHNICAL_HALT","TRADING_PAIR_ACTIVATION","TRADING_PAIR_DEACTIVATION","TRADING_PAIR_OFFBOARDING","TRADING_PAIR_CREATION","AUTOMATIC_RESUME"]},"FinancialInstrumentTableBase":{"type":"object","properties":{"symbol":{"description":"The financial instrument's symbol\n","type":"string","maxLength":255},"fullName":{"description":"The financial instrument's name\n","type":"string","maxLength":255},"status":{"description":"Trading status of the financial instrument\n","$ref":"#/components/schemas/FinancialInstrumentStatusEnum","readOnly":true},"isin":{"description":"International Securities Identification Number (ISIN) of the financial instrument\n","type":"string","pattern":"^[A-Z]{2}[0-9A-Z]{9}[0-9]$","maxLength":255},"dti":{"description":"Digital Token Identifier (DTI) of the financial instrument\n","type":"string","maxLength":255},"issuerName":{"description":"Name of the issuer of the financial instrument\n","type":"string","maxLength":255},"prospectusLink":{"description":"Link to further information about the financial instrument\n","type":"string","readOnly":true,"maxLength":255},"effectiveDate":{"description":"First day of active trading on 21X\n","type":"string","format":"date-time"},"terminationDate":{"description":"Last day of trading on 21X\n","type":"string","format":"date-time"},"smartContractAddress":{"description":"The blockchain address of the financial instrument's smart contract\n","type":"string","pattern":"^(0x)?[0-9a-fA-F]+$","maxLength":255}}},"FinancialInstrumentStatusEnum":{"type":"string","enum":["CREATED","APPROVED","ACTIVE","EXPIRED","DEACTIVATED"]}}}} ``` ## The OrderList object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"OrderList":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Order"}},"next_cursor":{"type":"string","maxLength":255},"total_count":{"type":"integer","format":"int64","minimum":0}}},"Order":{"required":["id","tradingPairId","orderKind","orderType","initialQuantity","remainingQuantity","address"],"type":"object","properties":{"id":{"type":"string","readOnly":true,"maxLength":255},"creationDate":{"type":"string","format":"date-time","readOnly":true},"modificationDate":{"type":"string","format":"date-time","readOnly":true},"externalOrderId":{"description":"ID generated by the order book smart contract\n","type":"integer","format":"int64","readOnly":true,"minimum":0},"tradingPairId":{"description":"The trading pair that the order belongs to\n","type":"string","maxLength":255},"orderKind":{"description":"The kind of the order (buy/sell)\n","$ref":"#/components/schemas/OrderKindEnum"},"orderType":{"description":"The type of the order (currently only limit orders)\n","$ref":"#/components/schemas/OrderTypeEnum"},"initialQuantity":{"description":"Initial order size in financial instrument (base) tokens (as sent to the order book)\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"remainingQuantity":{"description":"Remaining order size in financial instrument (base) tokens (can be lower than the initial quantity in case of partial executions)\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"priceLimit":{"description":"The price limit is mandatory for limit orders\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"status":{"description":"The status of the order\n","$ref":"#/components/schemas/OrderStatusEnum"},"statusReason":{"description":"The reason why an order was cancelled or rejected\n","$ref":"#/components/schemas/OrderStatusReasonEnum"},"statusChangeTime":{"description":"The date and time when the order was fully executed, rejected or cancelled\n","type":"string","format":"date-time"},"finalityStatus":{"description":"Indicates whether the current state of the order is considered final by 21X\n","$ref":"#/components/schemas/FinalityStatusEnum","readOnly":true},"ownerReportingData":{"description":"The bit string that the creator passed as reportingData to the smart contract, encoded as a hexadecimal string\n","type":"string","maxLength":255},"crossIdentifier":{"description":"32-bit integer that can be used to distinguish between participants using the same wallet, disabling self-trade checks between different cross-IDs.\n","type":"integer","format":"int64","minimum":0},"validUntil":{"description":"The latest date at which the order is automatically cancelled\n","type":"string","format":"date-time"},"executionCondition":{"description":"Execution condition specified during order creation (if any)\n","$ref":"#/components/schemas/OrderExecutionConditionEnum"},"address":{"description":"The address of the wallet that the order was sent from\n","type":"string","pattern":"^(0x)?[0-9a-fA-F]+$","maxLength":255}}},"OrderKindEnum":{"type":"string","enum":["BUY","SELL"]},"OrderTypeEnum":{"type":"string","enum":["LIMIT","MARKET"]},"OrderStatusEnum":{"type":"string","enum":["OPEN","COMPLETED","CANCELLED","REJECTED","CANCELLED_PARTIAL","REJECTED_PARTIAL"]},"OrderStatusReasonEnum":{"type":"string","enum":["N_A","EXECUTED_SUCCESSFULLY","CREATOR_CANCEL","ADMIN_CANCEL","PARTICIPANT_REQUEST","MARKET_CLOSE","AUTHORITY_REQUEST","VENUE_REQUEST","OTHER","SELF_TRADE","TOO_MANY_MATCHES","TICK_SIZE_VIOLATION","MINIMUM_VOLUME","MAXIMUM_VOLUME","MINIMUM_VALUE","MAXIMUM_VALUE","PRICE_COLLAR","UPPER_STATIC_PRICE_RANGE","LOWER_STATIC_PRICE_RANGE","UPPER_DYNAMIC_PRICE_RANGE","LOWER_DYNAMIC_PRICE_RANGE","EXECUTION_CONDITION_FOK","EXECUTION_CONDITION_IOC","EXECUTION_CONDITION_BOC"]},"FinalityStatusEnum":{"type":"string","enum":["NON_FINAL","FINAL"]},"OrderExecutionConditionEnum":{"type":"string","enum":["NONE","FILL_OR_KILL","IMMEDIATE_OR_CANCEL","BOOK_OR_CANCEL"]}}}} ``` ## The Order object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"Order":{"required":["id","tradingPairId","orderKind","orderType","initialQuantity","remainingQuantity","address"],"type":"object","properties":{"id":{"type":"string","readOnly":true,"maxLength":255},"creationDate":{"type":"string","format":"date-time","readOnly":true},"modificationDate":{"type":"string","format":"date-time","readOnly":true},"externalOrderId":{"description":"ID generated by the order book smart contract\n","type":"integer","format":"int64","readOnly":true,"minimum":0},"tradingPairId":{"description":"The trading pair that the order belongs to\n","type":"string","maxLength":255},"orderKind":{"description":"The kind of the order (buy/sell)\n","$ref":"#/components/schemas/OrderKindEnum"},"orderType":{"description":"The type of the order (currently only limit orders)\n","$ref":"#/components/schemas/OrderTypeEnum"},"initialQuantity":{"description":"Initial order size in financial instrument (base) tokens (as sent to the order book)\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"remainingQuantity":{"description":"Remaining order size in financial instrument (base) tokens (can be lower than the initial quantity in case of partial executions)\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"priceLimit":{"description":"The price limit is mandatory for limit orders\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"status":{"description":"The status of the order\n","$ref":"#/components/schemas/OrderStatusEnum"},"statusReason":{"description":"The reason why an order was cancelled or rejected\n","$ref":"#/components/schemas/OrderStatusReasonEnum"},"statusChangeTime":{"description":"The date and time when the order was fully executed, rejected or cancelled\n","type":"string","format":"date-time"},"finalityStatus":{"description":"Indicates whether the current state of the order is considered final by 21X\n","$ref":"#/components/schemas/FinalityStatusEnum","readOnly":true},"ownerReportingData":{"description":"The bit string that the creator passed as reportingData to the smart contract, encoded as a hexadecimal string\n","type":"string","maxLength":255},"crossIdentifier":{"description":"32-bit integer that can be used to distinguish between participants using the same wallet, disabling self-trade checks between different cross-IDs.\n","type":"integer","format":"int64","minimum":0},"validUntil":{"description":"The latest date at which the order is automatically cancelled\n","type":"string","format":"date-time"},"executionCondition":{"description":"Execution condition specified during order creation (if any)\n","$ref":"#/components/schemas/OrderExecutionConditionEnum"},"address":{"description":"The address of the wallet that the order was sent from\n","type":"string","pattern":"^(0x)?[0-9a-fA-F]+$","maxLength":255}}},"OrderKindEnum":{"type":"string","enum":["BUY","SELL"]},"OrderTypeEnum":{"type":"string","enum":["LIMIT","MARKET"]},"OrderStatusEnum":{"type":"string","enum":["OPEN","COMPLETED","CANCELLED","REJECTED","CANCELLED_PARTIAL","REJECTED_PARTIAL"]},"OrderStatusReasonEnum":{"type":"string","enum":["N_A","EXECUTED_SUCCESSFULLY","CREATOR_CANCEL","ADMIN_CANCEL","PARTICIPANT_REQUEST","MARKET_CLOSE","AUTHORITY_REQUEST","VENUE_REQUEST","OTHER","SELF_TRADE","TOO_MANY_MATCHES","TICK_SIZE_VIOLATION","MINIMUM_VOLUME","MAXIMUM_VOLUME","MINIMUM_VALUE","MAXIMUM_VALUE","PRICE_COLLAR","UPPER_STATIC_PRICE_RANGE","LOWER_STATIC_PRICE_RANGE","UPPER_DYNAMIC_PRICE_RANGE","LOWER_DYNAMIC_PRICE_RANGE","EXECUTION_CONDITION_FOK","EXECUTION_CONDITION_IOC","EXECUTION_CONDITION_BOC"]},"FinalityStatusEnum":{"type":"string","enum":["NON_FINAL","FINAL"]},"OrderExecutionConditionEnum":{"type":"string","enum":["NONE","FILL_OR_KILL","IMMEDIATE_OR_CANCEL","BOOK_OR_CANCEL"]}}}} ``` ## The Wallet object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"Wallet":{"required":["id","address","owner"],"type":"object","properties":{"id":{"type":"string","readOnly":true,"maxLength":255},"creationDate":{"type":"string","format":"date-time","readOnly":true},"modificationDate":{"type":"string","format":"date-time","readOnly":true},"address":{"description":"The blockchain address of the wallet\n","type":"string","pattern":"^(0x)?[0-9a-fA-F]+$","maxLength":255},"owner":{"description":"The ID of a legal entity or a natural person that this wallet belongs to\n","type":"string","format":"uuid","maxLength":255},"status":{"description":"Status of the wallet\n","$ref":"#/components/schemas/WalletStatusEnum","readOnly":true,"default":"CREATED"},"description":{"description":"Free text field to help the owner distinguish between multiple wallets\n","type":"string","maxLength":255},"designation":{"description":"Designated usage of the wallet (default: TRADING)\n","$ref":"#/components/schemas/WalletDesignationEnum","readOnly":true,"default":"TRADING"}}},"WalletStatusEnum":{"type":"string","enum":["CREATED","IN_VERIFICATION","VERIFIED","REMOVED","BLOCKED"]},"WalletDesignationEnum":{"type":"string","enum":["TRADING","MARKET_MAKER"]}}}} ``` ## The TradeList object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"TradeList":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Trade"}},"next_cursor":{"type":"string","maxLength":255},"total_count":{"type":"integer","format":"int64","minimum":0}}},"Trade":{"required":["id","transactionType","baseTokenSymbol","quoteTokenSymbol","baseTokenQuantity","quoteTokenQuantity","price"],"type":"object","properties":{"id":{"type":"string","readOnly":true,"maxLength":255},"sequenceNo":{"description":"Trade number generated by the order book\n","type":"integer","format":"int64","readOnly":true,"minimum":0},"transactionDate":{"description":"The time at which the corresponding block-chain block was generated\n","type":"string","format":"date-time","readOnly":true},"finalityDate":{"description":"The time since when the transaction is considered final by 21X.\n","type":"string","format":"date-time","readOnly":true},"transactionType":{"description":"The kind of trade (buy/sell)\n","$ref":"#/components/schemas/OrderKindEnum"},"baseTokenSymbol":{"description":"The symbol of the financial instrument token that was traded\n","type":"string","maxLength":255},"quoteTokenSymbol":{"description":"The e-money token that was used in the trade\n","type":"string","maxLength":255},"baseTokenQuantity":{"description":"The number of financial instrument tokens that were transferred\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"quoteTokenQuantity":{"description":"The number of e-money tokens that were transferred (excluding commission)\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"price":{"description":"The price point at which the trade was executed\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"commission":{"description":"The number of e-money tokens the participant paid as commission\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"orderId":{"description":"Link to the participant's order involved in the trade\n","type":"string","maxLength":255},"transactionHash":{"description":"Unique identifier of the corresponding blockchain transaction\n","type":"string","maxLength":255}}},"OrderKindEnum":{"type":"string","enum":["BUY","SELL"]}}}} ``` ## The Trade object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"Trade":{"required":["id","transactionType","baseTokenSymbol","quoteTokenSymbol","baseTokenQuantity","quoteTokenQuantity","price"],"type":"object","properties":{"id":{"type":"string","readOnly":true,"maxLength":255},"sequenceNo":{"description":"Trade number generated by the order book\n","type":"integer","format":"int64","readOnly":true,"minimum":0},"transactionDate":{"description":"The time at which the corresponding block-chain block was generated\n","type":"string","format":"date-time","readOnly":true},"finalityDate":{"description":"The time since when the transaction is considered final by 21X.\n","type":"string","format":"date-time","readOnly":true},"transactionType":{"description":"The kind of trade (buy/sell)\n","$ref":"#/components/schemas/OrderKindEnum"},"baseTokenSymbol":{"description":"The symbol of the financial instrument token that was traded\n","type":"string","maxLength":255},"quoteTokenSymbol":{"description":"The e-money token that was used in the trade\n","type":"string","maxLength":255},"baseTokenQuantity":{"description":"The number of financial instrument tokens that were transferred\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"quoteTokenQuantity":{"description":"The number of e-money tokens that were transferred (excluding commission)\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"price":{"description":"The price point at which the trade was executed\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"commission":{"description":"The number of e-money tokens the participant paid as commission\n","type":"string","pattern":"^(-)?[0-9][0-9]*(?:.[0-9]{1,18})?$","maxLength":255},"orderId":{"description":"Link to the participant's order involved in the trade\n","type":"string","maxLength":255},"transactionHash":{"description":"Unique identifier of the corresponding blockchain transaction\n","type":"string","maxLength":255}}},"OrderKindEnum":{"type":"string","enum":["BUY","SELL"]}}}} ``` ## The AppError object ```json {"openapi":"3.1.0","info":{"title":"EDX Public API Model","version":"1.0.0"},"components":{"schemas":{"AppError":{"required":["code","message"],"type":"object","properties":{"code":{"description":"A identifier that categorizes the error","type":"string"},"message":{"description":"A brief, human-readable message about the error","type":"string"},"status":{"description":"The HTTP response code","type":"integer","format":"int32"},"path":{"description":"A URI that identifies the specific occurrence of the error","type":"string"},"timestamp":{"type":"string","format":"date-time"},"details":{"description":"Detailed explanations of the error","type":"array","items":{"type":"string"}}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.21x.eu/api-reference-v1.0/models.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.