{"info":{"_postman_id":"01d3b7bb-bccf-4522-a516-bef4e08a8e8a","name":"DTN ProphetX® Web Services","description":"ProphetX Web services, in short **PXWeb**, provides the facility to access real time quotes and historical market information from a JSON and REST based web service.\n\nPXWeb end points are divided into four categories: Quotes, History, Information, and Option Series. Requests in the quotes category are for getting the most recent prices on a symbol. History is for requesting prices from specific time periods in the past and supports daily, minute, and tick history. Information contains a request for searching for symbols based on text strings and a request for querying the market hours of a symbol. The option series category contains on request for getting quotes on many futures options based on an option root and an expiration.\n\nFurther documentation is available at [https://pxweb.dtn.com](https://pxweb.dtn.com/).","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json","_exporter_id":"30545323"},"item":[{"name":"Quotes","item":[{"name":"Quotes","request":{"method":"GET","header":[],"url":{"raw":"https://{{host}}/market_data/quotes?symbol=@C`%23%23&fieldGroup=price&fields=figi","protocol":"https","host":["{{host}}"],"path":["market_data","quotes"],"query":[{"key":"symbol","value":"@C`%23%23","description":"A comma separated list of security symbols, security aliases, or search patterns."},{"key":"fieldGroup","value":"price","description":"Fields groups are collections of fields that are commonly used together. If this parameter is not set, it will default to 'complete' which returns all available fields. Setting the fields parameter will override the default fieldGroups. Specifying both fields and fieldGroups will return the union of the fields and field groups."},{"key":"fields","value":"figi","description":"This parameter can be used to override the default fields returned from quote requests. Pass a comma separated list of field names to select what values are returned. If fields and field groups are specified, the returned fields will be the union of the two. If only fields are specified, then only those fields will be returned. The field names are the same as the properties of a quote object."},{"key":"symbolLimit","value":"10","description":"The number of symbols to return in one request up to a maximum of 4000.","disabled":true},{"key":"pageToken","value":"","description":"A page token returned from a previous request. It is used to resume a request that matched more symbols than the SymbolLimit allowed in one request. ","disabled":true},{"key":"market","value":"CBT","description":"A market identifier to apply to all symbols and patterns in the request","disabled":true}]}},"response":[]},{"name":"Greeks","request":{"method":"GET","header":[],"url":{"raw":"https://{{host}}/market_data/quotes/greeks?symbol=@C`%23%23C{0-9}","protocol":"https","host":["{{host}}"],"path":["market_data","quotes","greeks"],"query":[{"key":"symbol","value":"@C`%23%23C{0-9}","description":"A comma separated list of security symbols, security aliases, or search patterns."},{"key":"fieldGroup","value":"price","description":"Fields groups are collections of fields that are commonly used together. If this parameter is not set, it will default to 'complete' which returns all available fields. Setting the fields parameter will override the default fieldGroups. Specifying both fields and fieldGroups will return the union of the fields and field groups.","disabled":true},{"key":"fields","value":"description","description":"This parameter can be used to override the default fields returned from quote requests. Pass a comma separated list of field names to select what values are returned. If fields and field groups are specified, the returned fields will be the union of the two. If only fields are specified, then only those fields will be returned. The field names are the same as the properties of a quote object.","disabled":true},{"key":"basis","value":"settlementPrice","description":"A price FID to be used as the basis of the calculation, where typical values are \"recent\" and \"settlementPrice\". Default value is recent.","disabled":true},{"key":"symbolLimit","value":"10","description":"The number of symbols to return in one request up to a maximum of 4000.","disabled":true},{"key":"pageToken","value":null,"description":"A page token returned from a previous request. It is used to resume a request that matched more symbols than the SymbolLimit allowed in one request. ","disabled":true}]}},"response":[]},{"name":"Equity Scans","request":{"method":"GET","header":[],"url":{"raw":"https://{{host}}/market_data/quotes/equity-scans?report=A&market=ALL","protocol":"https","host":["{{host}}"],"path":["market_data","quotes","equity-scans"],"query":[{"key":"report","value":"A","description":"Desired report code, which can be Gainers(G), Percent Gainers(PG), Losers(L), Percent Losers(PL), Active(A), Volatile(V), 52 Week High(52H), 52 Week Low(52L). Anything else defaults to A.\n\nAvailable values : G, PG, L, PL, A, V, 52H, 52L"},{"key":"market","value":"ALL","description":"The market code which can be NYSE, NYSEAMERICAN, NASDAQ, or ALL."},{"key":"fieldGroup","value":"price","description":"Fields groups are collections of fields that are commonly used together. If this parameter is not set, it will default to 'complete' which returns all available fields. Setting the fields parameter will override the default fieldGroups. Specifying both fields and fieldGroups will return the union of the fields and field groups.","disabled":true},{"key":"fields","value":"description","description":"This parameter can be used to override the default fields returned from quote requests. Pass a comma separated list of field names to select what values are returned. If fields and field groups are specified, the returned fields will be the union of the two. If only fields are specified, then only those fields will be returned. The field names are the same as the properties of a quote object.","disabled":true},{"key":"limit","value":"10","description":"The maximum number of symbols to return.","disabled":true}]}},"response":[]}]},{"name":"History","item":[{"name":"Daily History","request":{"method":"GET","header":[],"url":{"raw":"https://{{host}}/market_data/history/daily?symbol=@C@1&limit=5","protocol":"https","host":["{{host}}"],"path":["market_data","history","daily"],"query":[{"key":"symbol","value":"@C@1","description":"A comma separated list of security symbols, security aliases, or search patterns."},{"key":"interval","value":"1","description":"The number of bars to combine together into one bar.","disabled":true},{"key":"startdate","value":"2024-01-01","description":"Earliest date to include in the result. Date in ISO 8601 format YYYY-MM-DD","disabled":true},{"key":"enddate","value":"2024-06-01","description":"The latest date to include in the result. Date in ISO 8601 format YYYY-MM-DD","disabled":true},{"key":"limit","value":"5","description":"The maximum number of rows of history to return per symbol. The maximum number of points for a single symbol in one request is 3,660. For requests that match multiple symbols, a per symbol limit will be set so that one entire request doesn't return more than 1,020,000 data points."},{"key":"symbolLimit","value":null,"description":"The number of symbols to return in one request up to a maximum of 4000.","disabled":true},{"key":"pageToken","value":null,"description":"A page token returned from a previous request. It is used to resume a request that matched more symbols than the SymbolLimit allowed in one request. ","disabled":true},{"key":"market","value":"CBT","description":"A market identifier to apply to all symbols and patterns in the request","disabled":true}]}},"response":[]},{"name":"Minute History","request":{"method":"GET","header":[],"url":{"raw":"https://{{host}}/market_data/history/minute?symbol=@C@1&limit=60","protocol":"https","host":["{{host}}"],"path":["market_data","history","minute"],"query":[{"key":"symbol","value":"@C@1","description":"A comma separated list of security symbols, security aliases, or search patterns."},{"key":"interval","value":"1","description":"The number of bars to combine together into one bar.","disabled":true},{"key":"starttime","value":"2024-08-01T00:00:00","description":"Earliest datetime to include in the result. Datetime in ISO 8601 format YYYY-MM-DDTHH:MM:SS","disabled":true},{"key":"endtime","value":"2024-08-10T00:00:00","description":"The latest datetime to include in the result. Datetime in ISO 8601 format YYYY-MM-DDTHH:MM:SS","disabled":true},{"key":"limit","value":"60","description":"The maximum number of rows of history to return per symbol. The maximum number of points for a single symbol in one request is 100,000. For requests that match multiple symbols, a per symbol limit will be set so that one entire request doesn't return more than 1,020,000 data points."},{"key":"symbolLimit","value":"","description":"The number of symbols to return in one request up to a maximum of 4000.","disabled":true},{"key":"pageToken","value":"","description":"A page token returned from a previous request. It is used to resume a request that matched more symbols than the SymbolLimit allowed in one request. ","disabled":true},{"key":"market","value":"","description":"A market identifier to apply to all symbols and patterns in the request","disabled":true}]}},"response":[]},{"name":"TIck History","request":{"method":"GET","header":[],"url":{"raw":"https://{{host}}/market_data/history/tick?symbol=@C@1&limit=10","protocol":"https","host":["{{host}}"],"path":["market_data","history","tick"],"query":[{"key":"symbol","value":"@C@1","description":"A comma separated list of security symbols, security aliases, or search patterns."},{"key":"filter","value":"1","description":"0 returns Trades, Bid, and Asks.  1 returns just Trades","disabled":true},{"key":"interval","value":"1","description":"The number of ticks to combine together into one bar.","disabled":true},{"key":"starttime","value":"2024-08-19T13:00:00","description":"Earliest datetime to include in the result. Datetime in ISO 8601 format YYYY-MM-DDTHH:MM:SS","disabled":true},{"key":"endtime","value":"2024-08-19T14:00:00","description":"The latest datetime to include in the result. Datetime in ISO 8601 format YYYY-MM-DDTHH:MM:SS","disabled":true},{"key":"limit","value":"10","description":"The maximum number of rows of history to return per symbol. The maximum number of points for a single symbol in one request is 50,000. For requests that match multiple symbols, a per symbol limit will be set so that one entire request doesn't return more than 1,020,000 data points."},{"key":"symbolLimit","value":"","description":"The number of symbols to return in one request up to a maximum of 4000.","disabled":true},{"key":"pageToken","value":"","description":"A page token returned from a previous request. It is used to resume a request that matched more symbols than the SymbolLimit allowed in one request. ","disabled":true},{"key":"market","value":"","description":"A market identifier to apply to all symbols and patterns in the request","disabled":true}]}},"response":[]},{"name":"Forward Curve","request":{"method":"GET","header":[],"url":{"raw":"https://{{host}}/market_data/history/forward-curve?root=@C","protocol":"https","host":["{{host}}"],"path":["market_data","history","forward-curve"],"query":[{"key":"root","value":"@C","description":"A single futures root. A futures root is the part of a symbol that does not change with expiration."},{"key":"curvedate","value":null,"description":"The date to return prices for when requesting a forward curve.  Leave blank for most recent.","disabled":true},{"key":"limit","value":"200","description":"The maximum number of symbols to return.","disabled":true},{"key":"market","value":"","description":"A market identifier to apply to all symbols and patterns in the request","disabled":true}]}},"response":[]}]},{"name":"Information","item":[{"name":"Symbol Search","request":{"method":"GET","header":[],"url":{"raw":"https://{{host}}/market_data/symbol-search?searchtext=Microsoft","protocol":"https","host":["{{host}}"],"path":["market_data","symbol-search"],"query":[{"key":"searchtext","value":"Microsoft","description":"Keywords to match against symbols and their descriptions"},{"key":"limit","value":"200","description":"The maximum number of symbols to return.","disabled":true}]}},"response":[]},{"name":"Market Hours","request":{"method":"GET","header":[],"url":{"raw":"https://{{host}}/market_data/metadata/market-hours?symbol=@C@1","protocol":"https","host":["{{host}}"],"path":["market_data","metadata","market-hours"],"query":[{"key":"symbol","value":"@C@1","description":"A comma separated list of security symbols, security aliases, or search patterns."},{"key":"startdate","value":null,"description":"Earliest date to include in the result. Date in ISO 8601 format YYYY-MM-DD","disabled":true},{"key":"enddate","value":null,"description":"The latest date to include in the result. Date in ISO 8601 format YYYY-MM-DD","disabled":true},{"key":"symbolLimit","value":null,"description":"The number of symbols to return in one request up to a maximum of 4000.","disabled":true},{"key":"pageToken","value":null,"description":"A page token returned from a previous request. It is used to resume a request that matched more symbols than the SymbolLimit allowed in one request.","disabled":true},{"key":"market","value":null,"description":"A market identifier to apply to all symbols and patterns in the request.","disabled":true}]}},"response":[]}]},{"name":"Option Series","item":[{"name":"Option Series","request":{"method":"GET","header":[],"url":{"raw":"https://{{host}}/market_data/options/series?optionPrefix=@CZ24","protocol":"https","host":["{{host}}"],"path":["market_data","options","series"],"query":[{"key":"optionPrefix","value":"@CZ24","description":"A prefix is a combination of an option root and a maturity."},{"key":"fields","value":"description","description":"This parameter can be used to override the default fields returned from quote requests. Pass a comma separated list of field names to select what values are returned. If fields and field groups are specified, the returned fields will be the union of the two. If only fields are specified, then only those fields will be returned. The field names are the same as the properties of a quote object.","disabled":true},{"key":"fieldGroup","value":"price","description":"Fields groups are collections of fields that are commonly used together. If this parameter is not set, it will default to 'complete' which returns all available fields. Setting the fields parameter will override the default fieldGroups. Specifying both fields and fieldGroups will return the union of the fields and field groups.","disabled":true},{"key":"limit","value":"200","description":"Limit on the number of strikes to return. If this parameter is specified, then Limit number of strikes above and below the money will be returned.","disabled":true}]}},"response":[]}]}],"auth":{"type":"basic","basic":[{"key":"password","value":"{{password}}","type":"string"},{"key":"username","value":"{{userid}}","type":"string"}]},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"host","value":"pxweb.dtn.com","type":"string"},{"key":"userid","value":"YOUR USERID","type":"string"},{"key":"password","value":"YOUR PASSWORD","type":"string"}]}