API Documentation

Basic Usage Info

Just a heads up. This API is consumption only! You can't just submit cards directly into our database! You can only use GET requests on this API.

Also, please try not to do an insane amount of API calls each day!
The API doesn't require authentication, and it is open for anyone to use. However, the API is run by me on my VPS that I pay for monthly, so please try not to hurt my wallet too much.

Getting Started - Prerequisites

Before you get into using our API heavily, You are going to need some way or somewhere in which you can send HTTP requests and receive JSON data. There are many options for how you can send HTTP requests and receive a response.

Here are a few examples:

• Using cURL, which is a tool that allows you to send data to and from a server. You can use cURL to send data to and from a web server via HTTP. You can make API requests this way!
  Click here to see the cURL documentation.
• Using Python, you can import/install the requests library, which allows you to make web requests and receive responses, which can be converted to JSON.
  Click here to see the Python documentation for the requests library.
• Using Java, you can import the HTTPClient library, which allows you to make web requests via HTTP and receive HTTP responses.
  Click here to see the Java documentation for the HTTPClient package.
• Using Javascript, you can use the FetchAPI built in interface, which allows you to make HTTP requests in web applications and handle responses.
  Click here to see the documentation for the FetchAPI interface.
• And if you want to test the API before using it directly, you could also try out Postman. Postman lets you try out API endpoints to see if they work properly.
  Click here to see the Postman website, where you can install the application.

I personally recommend testing the API out using the Python requests and json library before trying it elsewhere, but that is just my suggestion.

Once you have a place in which you can make web requests to the OPTCG API!

Getting Started - Accessing the API

For this portion, I will be using Python and the requests library to show how you can access the API. I use PyCharm as my IDE, but there are a few out there that work just as good.

First, open up whatever Python IDE you use, and use the following line of code in your terminal to install the requests library to the environment.

                        

                            pip install requests

                        

                    

Once you have the requests library installed on your environment, create a new python file to work in.

After you create a new python file to work in, make sure to import the requests library so that you can then use it:

                        

                            import requests

                        
                    

With the requests library installed and imported in the python file, you can then begin making web requests by using the .get function.

Here is an example of us using the .get function on the /sets/{set_id}/ endpoint:

                        

                            import requests
                            response = requests.get('https://optcgapi.com/api/sets/card/OP01-001/')
                            response_text = response.json()

                        

                    

Now, you will have a python dictionary equivalent of the JSON data received in the web response!

You can do what you want with the data from here!

Here is how the JSON will look when you call the api/sets/card/{card_id}/ endpoint: (We are passing in the card_id: OP01-001)

Available API Endpoints

• /api/allSets/
• /api/allDecks/
• /api/sets/{set_id}/
• /api/sets/card/{card_id}/
• /api/decks/{st_id}/
• /api/decks/card/{card_id}/
• /api/sets/{set_id}/{card_color}/
• /api/decks/{st_id}/{card_color}/