Product Reference Data
In order to populate the trade submission requests, all clients must retrieve the reference data necessary to enter the correct proprietary values into the appropriate FIXML elements.
To obtain product reference data MQ Series clients must use the FIXML Product Reference Files (FPRF) generated daily by CME Group. The data will be loaded daily for all products across the NYMEX, COMEX, CME, CBOT, and GME exchanges. The FPRF provides a complete list of all contracts for all products.
Find the FPRF files located on the CME Public FTP server at ftp://ftp.cmegroup.com/fprf/.
HTTP clients can use FPRF or Request/Response methods over CME ClearPort API.
Any user wishing to obtain a complete list of all contracts should use the FPRF.
See Also
Request/Response Method
CME ClearPort API provides various request and response methods to retrieve product reference data. Each request type using the FIXML Security Definition Request message has its own predefined Request Type (ReqTyp) number.
Clients must specify a Request ID on each request, which clients must use to uniquely identify the response to its specific request.
All Contract Month or Option Series Requests must include a SecurityID (e.g ID=”CL”) specifying the product.
The API supports the creation of dynamic strike prices for certain options (eligible products are identified by ListMeth=”1”), which are available on subsequent downloads.
Message Specification
Message Type | FIXML Abbreviation | Description |
---|---|---|
Security Definition Request | SecDefReq | Sent by submitter to obtain a complete list of products, futures contracts for a particular product, options series for a particular product, or synthetic spreads (underlying Options on Combos). |
Derivative Security List Request | DevSecListReq | Sent by submitter to obtain a list of options strikes for a specific options series. |
Security Definition | SecDef | Response for Security Definition Request. |
Derivative Security List | DerivSecList | Response for Derivative Security List Request. |
Request Types
Product Request
Request Type | Description | Examples |
---|---|---|
Product Request - no filter | All products requested: Request Type (ReqTyp) = 100 | FIXML v="5.0 SP2" xv="109" s="20090815" cv="CME.0001">
<SecDefReq ReqID="123412" ReqTyp="100">
<Hdr SID="BRKR" SSub="user123" TID="CME" TSub="CPAPI"/>
</SecDefReq>
</FIXML> |
Filter by Product Exchange |
| <FIXML v="5.0 SP2" xv="109" s="20090815" cv="CME.0001">
<SecDefReq ReqID="123443" ReqTyp="100">
<Hdr SID="PLTFM" SSub="user789" TID="CME" TSub="CPAPI"/>
<Instrmt Exch="CME"/>
</SecDefReq>
</FIXML> |
Filter by Product Exchange and Security Type |
| <FIXML v="5.0 SP2" xv="109" s="20090815" cv="CME.0001">
<SecDefReq ReqID="123477" ReqTyp="100">
<Hdr SID="BRKR" SSub="user123" TID="CME" TSub="CPAPI"/>
<Instrmt Exch="NYMEX" SecTyp="FUT"/>
</SecDefReq>
</FIXML> |
Filter by Product Exchange, Security Type and Security ID (w/ source code H) |
| <FIXML v="5.0 SP2" xv="109" s="20090815" cv="CME.0001">
<SecDefReq ReqID="123465" ReqTyp="100">
<Hdr SID="BRKR" SSub="user123" TID="CME" TSub="CPAPI"/>
<Instrmt Exch="CBT" SecTyp="OOF" ID="ZC" Src="H"/>
</SecDefReq>
</FIXML> |
Futures Maturity Request
Request Type | Description | Examples |
---|---|---|
Request for all futures contracts | The Request Type (ReqTyp) number for the list of Futures contracts with product family information request is 103. Filters on Product Exchange, Security Type, and Security ID (w/ source code H). | <FIXML v="5.0 SP2" xv="109" s="20090815" cv="CME.0001">
<SecDefReq ReqID="123416" ReqTyp="103">
<Hdr SID="PLTFM" SSub="user789" TID="CME" TSub="CPAPI"/>
<Instrmt Exch="CBT" SecTyp="FUT" ID="3YR" Src="H"/>
</SecDefReq>
</FIXML> |
Request for all futures contracts - no product information | The Request Type (ReqTyp) number for the list of Futures contracts without product family information request is 104. Filters on Product Exchange, Security Type, and Security ID (w/ source code H). | <FIXML v="5.0 SP2" xv="109" s="20090815" cv="CME.0001">
<SecDefReq ReqID="123412" ReqTyp="104">
<Hdr SID="BRKR" SSub="user123" TID="CME" TSub="CPAPI"/>
<Instrmt Exch="CBT" SecTyp="FUT" ID="3YR" Src="H"/>
</SecDefReq>
</FIXML> |
Request for all futures contracts with maturity month | A request for product family information for the specified futures contract. Filters on Product Exchange, Security Type, Security ID (w/ source code H) and Maturity Month. | <FIXML v="5.0 SP2" xv="109" s="20090815" cv="CME.0001">
<SecDefReq ReqID="123462" ReqTyp="103">
<Hdr SID="BRKR" SSub="user123" TID="CME" TSub="CPAPI"/>
<Instrmt Exch="CBT" SecTyp="FUT" ID="3YR" Src="H" MMY="200912"/>
</SecDefReq>
</FIXML> |
Request for all futures contracts with maturity month and no product information | A request for the specified futures contract without product family information (basically a check that the contract is valid). Filters on Product Exchange, Security Type, Security ID (w/ source code H) and Maturity Month. | <FIXML v="5.0 SP2" xv="109" s="20090815" cv="CME.0001">
<SecDefReq ReqID="123418" ReqTyp="104">
<Hdr SID="PLTFM" SSub="user789" TID="CME" TSub="CPAPI"/>
<Instrmt Exch="CBT" SecTyp="FUT" ID="3YR" Src="H" MMY="200912"/>
</SecDefReq>
</FIXML> |
Option Series Request
Request Type | Description | Examples |
---|---|---|
Options Series with product family information | The Request Type (ReqTyp) number for the list of Options Series with product family information request is 101. Security type indicates an option. | <FIXML v="5.0 SP2" xv="109" s="20090815" cv="CME.0001">
<SecDefReq ReqID="123412" ReqTyp="101">
<Hdr SID="PLTFM" SSub="user789" TID="CME" TSub="CPAPI"/>
<Instrmt Exch="NYMEX" SecTyp="OOF" ID="LN" Src="H"/>
</SecDefReq>
</FIXML> |
Options Series without product family information | The Request Type (ReqTyp) number for the list of Options Series without product family information request is 102. Security type indicates an option. | <FIXML v="5.0 SP2" xv="109" s="20090815" cv="CME.0001">
<SecDefReq ReqID="123497" ReqTyp="102">
<Hdr SID="BRKR" SSub="user123" TID="CME" TSub="CPAPI"/>
<Instrmt Exch="NYMEX" SecTyp="OOC" ID="IA" Src="H"/>
</SecDefReq>
</FIXML> |
Spread Request
Request Type | Description | Examples |
---|---|---|
Spread Request | Allows clients to request a list of synthetic spreads that are underlyings for Options on Combos.The Request Type (ReqTyp) number for the synthetic spread request type is 105. Filter options:
| <FIXML v="5.0 SP2" xv="109" s="20090815" cv="CME.0001">
<SecDefReq ReqID="123452" ReqTyp="105">
<Hdr SID="PLTFM" SSub="user789" TID="CME" TSub="CPAPI"/>
<Instrmt Exch="NYMEX" ID="CA" Src="H"/>
</SecDefReq>
</FIXML> With Maturity Date: <FIXML v="5.0 SP2" xv="109" s="20090815" cv="CME.0001">
<SecDefReq ReqID="123429" ReqTyp="105">
<Hdr SID="BRKR" SSub="user123" TID="CME" TSub="CPAPI"/>
<Instrmt Exch="NYMEX" ID="CA" Src="H" MMY="200912"/>
</SecDefReq>
</FIXML> |
How was your Client Systems Wiki Experience? Submit Feedback
Copyright © 2024 CME Group Inc. All rights reserved.