How to Request IPF

How to request IPF

To request IPF:

  1. Go to IPF web service.

  2. Enter your password and login.

  3. Use parameters to make a request.

  4. Check that the last line text in the output is "##COMPLETE". Otherwise, you receive an incomplete file.

Note

Use demo/demo credentials to check the list of available parameters.

Wildcards

Text format supports wildcards like * - multiple characters and ? - one character. For example:

curl -X GET \
-u user:password \
'https://tools.dxfeed.com/ipf?SYMBOL=?TOP10*&DESCRIPTION=*NASDAQ*'

This request returns all Top10 indexes for Nasdaq.

#INDEX::=TYPE,SYMBOL,DESCRIPTION,COUNTRY,OPOL,CURRENCY,TRADING_HOURS
INDEX,$TOP10L/Q,NASDAQ Top 10 losers by absolute net change,US,dxFeed,USD,dxFeedUS(0=09301610)
INDEX,$TOP10PG/Q,NASDAQ Top 10 gainers by relative net change,US,dxFeed,USD,dxFeedUS(0=09301610)
INDEX,$TOP10PL/Q,NASDAQ Top 10 losers by relative net change,US,dxFeed,USD,dxFeedUS(0=09301610)
INDEX,$TOP10G/Q,NASDAQ Top 10 gainers by absolute net change,US,dxFeed,USD,dxFeedUS(0=09301610)
INDEX,$TOP10V/Q,NASDAQ Top 10 gainers by volume,US,dxFeed,USD,dxFeedUS(0=09301610) ==COMPLETE

Request Examples

Stock

Supported methods: GET

Web

Request example

Bash

curl -X GET \
-u user:password \
'https://tools.dxfeed.com/ipf?TYPE=STOCK&SYMBOL=GOOG&fields=SYMBOL,DESCRIPTION,CURRENCY'

Reply

#STOCK::=TYPE,SYMBOL,DESCRIPTION,CURRENCY
STOCK,GOOG,Alphabet Inc. - Class C Capital Stock,USD

Futures

Web

Request example

Bash

curl -X GET \
-u user:password \
'https://tools.dxfeed.com/ipf?TYPE=FUTURE&SYMBOL=/YGM??:IFUS&fields=DESCRIPTION,CURRENCY,MULTIPLIER,PRODUCT,LAST_TRADE'

Reply

#FUTURE::=TYPE,SYMBOL,DESCRIPTION,CURRENCY,MULTIPLIER,PRODUCT,LAST_TRADE
FUTURE,/YGM22:IFUS,Mini Gold Futures - ICUS - Jun22,USD,32.15,/YG:IFUS,2022-06-28
FUTURE,/YGM19:IFUS,Mini Gold Futures - ICUS - Jun19,USD,32.15,/YG:IFUS,2019-06-26
FUTURE,/YGM21:IFUS,Mini Gold Futures - ICUS - Jun21,USD,32.15,/YG:IFUS,2021-06-28
FUTURE,/YGM23:IFUS,Mini Gold Futures - ICUS - Jun23,USD,32.15,/YG:IFUS,2023-06-28
FUTURE,/YGM20:IFUS,Mini Gold Futures - ICUS - Jun20,USD,32.15,/YG:IFUS,2020-06-26
In this section: