polygon-io / issues

Quickly track and report problems with polygon.io
29 stars 0 forks source link

/v3/reference/tickers documentation issue #181

Open SamuelLabrador opened 2 years ago

SamuelLabrador commented 2 years ago

Describe the bug Hi, I'm using the /v3/reference/tickers endpoint and am seeing some inconsistencies with documentation and the data being delivered.

When getting tickers for the crypto market I'm not seeing the following fields in the documentation:

Also, in the documentation, I was under the impression that these fields would always be returned in the result object. When getting crypto symbols, they weren't delivered. Should probably be listed as optional:

Stormy110 commented 2 years ago

Hello there, thanks for reaching out and sharing this! I can make a note with my team to adjust the docs. The currency symbol is the currency that is pairing with the crypto coin, like USD or EUR. The base_currency_symbol would be the crypto symbol like BTC or ETH, and the base_currency_name would be the name of the crypto.

Cryptos do not have CIK, FIGI, or Primary exchanges so those fields are not returned. I can also make a note with my team to add that those are only returned for stocks. Apologies for the confusion!