[Document] pepy api endpoint's

[prudhvigodithi]

Hey, https://pepy.tech/ site is amazing way to get the package download stats, I have also noticed it makes internal api calls to https://api.pepy.tech/api/v2/projects/<project_id> (found from GH links #118), but I dont see there is any README regarding these API endpoints? So checking to see if we can continue to use these API endpoints or if we can officially add them to the README file :), Happy to raise a PR as well to update the README.
Thank you
@psincraian

[psincraian]

Hey @prudhvigodithi, thanks for being patient. You can use them and if you can raise a PR would be perfect.

But please, add some throttling do not exhaust our server resources :-)

[prudhvigodithi]

Hey @psincraian thanks for confirming, can you please share the best possible way to add some throttling so that It can be helpful for the community to not accidentally exhaust the server resources.
Thank you

[psincraian]

The easiest solution is to have something like a time.sleep(). For example:

import time
import requests

for i in range(10):
    requests.get('http://example.com')
    time.sleep(1)

If you want to go more professional you can use ratelimit library:

from datetime import timedelta
from ratelimit import limits
import requests

@limits(calls=1, period=timedelta(seconds=60).total_seconds())
def get_foobar():
    response = requests.get('https://httpbin.org/get')

[prudhvigodithi]

Hey @psincraian I have noticed the API https://api.pepy.tech/api/v2/projects/opensearch-py that works now have the following error

{
"message": "Invalid API Key"
}

Can you please suggest the right UR ?
Adding @aaronreidsmith

[psincraian]

Hey,

Now you need to register and create an API Key. It will remain free, but I will add some throttling in the future because some people was abusing it.

Feel free to register a user and then an API Key

[dnth]

I have a badge for my github repo that previously worked using the endpoint without API key:

This is the URL for the badge - https://img.shields.io/badge/dynamic/json?style=for-the-badge&label=downloads&query=%24.total_downloads&url=https%3A%2F%2Fapi.pepy.tech%2Fapi%2Fv2%2Fprojects%2Ffastdup&color=lightblue

But with the API key implementation the badge no longer works. How can I make the badge show the total downloads again with the API key?

[jordarlu]

Hey,

Now you need to register and create an API Key. It will remain free, but I will add some throttling in the future because some people was abusing it.

Feel free to register a user and then an API Key

Hello, @psincraian , a following up question, per the instruction you mentioned above, I registered a user and created an API key from it. With that key, it worked well to fetch the metrics I needed yesterday, but with the same key, the API went fail today .. is the key only valid 24 hours probably? if that is the case, is there an API to refresh Key or creating a new key?

< HTTP/2 401 
< date: Tue, 31 Oct 2023 17:33:34 GMT
< content-length: 29
< cache-control: no-cache, no-store, max-age=0, must-revalidate
< expires: 0
< pragma: no-cache
< strict-transport-security: max-age=31536000 ; includeSubDomains
< vary: Origin
< vary: Access-Control-Request-Method
< vary: Access-Control-Request-Headers
< www-authenticate: Bearer
< x-content-type-options: nosniff
< x-frame-options: DENY
< x-xss-protection: 0
< cf-cache-status: DYNAMIC
< report-to: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=7aEWqwcQ0GQnPOJfsXNd9nfhFkLzXUX%2BSkHU%2FUDTkFycVEatKVt6EbZ3fgTCKW%2BKYdlUGKAag5X7DcSzmUGykjXdVyeL6p%2B7zTUKW2dQpqd0x6LQj2PqSYLbx29C1c42lQMMmvp511NW4ZXF"}],"group":"cf-nel","max_age":604800}
< nel: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
< server: cloudflare
< cf-ray: 81eda4d1d8cbec98-SEA
< alt-svc: h3=":443"; ma=86400

Could you further suggest what might have caused this error? and how to address it ? much appreciate it!!

[psincraian]

Can you try again? Please paste the headers as before, I added a new RequestId header to identify all the traces