From 4b4d4cb9015c83f2447604ad2c9450fd769743fb Mon Sep 17 00:00:00 2001 From: Tee Date: Tue, 23 Mar 2021 00:21:34 -0400 Subject: [PATCH] Add API configuration steps --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index c838946..c14f1bb 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,10 @@ Version 1 of this SDK is officially depricated. Version 2 stable release this SD yarn add pokemon-tcg-sdk-typescript +It is recommended to use an API key for version 2 of the API. By default, requests are limited to 20,000/day. Requests are rate limited to 1000 requests a day, and a maximum of 30 per minute. + +To use the SDK with an API key, create an account at https://dev.pokemontcg.io to grab an API key. Then set your API key to the environment variable POKEMONTCG_API_KEY in a .env file. Make sure to use this exact environment variable, otherwise the SDK will not be able to read the API key. + ## Class Definitions ### Card