[documentation] Add example calls for the Crypto endpoints #564
Conversation
Added a couple of examples for Crypto Documentation. It needs some more work and a bit more meat, but this is possibly better than no documentation.
Codecov Report
@@ Coverage Diff @@
## master #564 +/- ##
=======================================
Coverage 94.73% 94.73%
=======================================
Files 5 5
Lines 228 228
=======================================
Hits 216 216
Misses 12 12 Continue to review full report at Codecov.
|
hydrosquall
changed the title
There was a problem hiding this comment.
Thanks for helping out @GenusGeoff ! I have 2 suggestions for us to make to both lines, but this gets us started on a great foot. After these changes are made, I'll be happy to bring this in.
As follow-ups for you or any future contributors, additional changes that should be documented before we can close out #520
- Add an example for
get_crypto_metadata - Add lines to the call showing all the available URL arguments for each method by looking at the code in the diff that introduced these features:
|
|
||
| .. code-block:: python | ||
| # NOTE: Crypto symbol MUST be encapsulated in brackets as a Python list! | ||
| ``crypto_price = client.get_crypto_top_of_book(['BTCUSD'])`` |
There was a problem hiding this comment.
We can get syntax highlighting if we remove the backticks (``) and indent the python code, like so:
.. code-block:: python
# NOTE: Crypto symbol MUST be encapsulated in brackets as a Python list!
crypto_price = client.get_crypto_top_of_book(['BTCUSD'])
| @@ -138,6 +138,20 @@ To receive results in ``pandas`` format, use the ``get_dataframe()`` method: | |||
|
|
|||
| You can specify any of the end of day frequencies (daily, weekly, monthly, and annually) or any intraday frequency for both the ``get_ticker_price`` and ``get_dataframe`` methods. Weekly frequencies resample to the end of day on Friday, monthly frequencies resample to the last day of the month, and annually frequencies resample to the end of day on 12-31 of each year. The intraday frequencies are specified using an integer followed by "Min" or "Hour", for example "30Min" or "1Hour". | |||
|
|
|||
|
|
|||
| You can obtain top-of-book Cryptocurrency quotes from the ``get_crypto_top_of_book()`` method. | |||
There was a problem hiding this comment.
Cryptocurrency should be lowercase, as it's not a proper noun.
There was a problem hiding this comment.
Hey @hydrosquall, I'm not sure if the changes I made are showing for you. I did make the requested changes, but I see no record of them. I might be lost in the GitHub ether here.
There was a problem hiding this comment.
Hi @GenusGeoff, thanks for checking in. Currently I only see the changes from December (screenshot here).
Is it possible that the changes are on your local git repository, but haven't been pushed up to Github yet?
Alternately, if you have the raw text for what you intended to add, feel free to post it as a comment on this PR, and I can help you get it added to the branch.
|
NOTE: The segments would need to be copy-pasted as this file is behind the current one with the fundamental data added. (Or otherwise pulled, edited and merged). |
Added a couple of examples for Crypto Documentation. It needs some more work and a bit more meat, but this is possibly better than no documentation.
🎉 Hello there 🎉! Thanks for taking the time to contribute to
Tiingo-Python!Summary of Changes
Checklist
HISTORY.rstwith an entry summarizing your change