Quickstart
This guide will get you ready to use the CollateralXP API. First, we'll cover how to get started using one of our API clients and how to make your first API request. We'll also look at where to go next to find all the information you need to take full advantage of our powerful REST API.
Before using the CollateralXP API, please request your API key by contacting us at support@collateralxp.com.
Choose your client
Before making your first API request, pick which API client you will use. In addition to good ol' cURL HTTP requests, CollateralXP offers clients for Ruby and JavaScript. In the following example, you can see how to install each client.
# cURL is most likely already installed on your machine
curl --version
Making your first API request
After picking your preferred client, you can make your first call to the CollateralXP API. Below, you can see how to send a GET request to the Configurations endpoint to get a list of your account configurations. In the cURL example.
curl -G https://staging.app.collateralxp.com/api/v1/clients/{client_id}/configurations \
-H "X-Api-Key: {api_key}"
What's next?
Great, you're now set up with an API client and have made your first request to the API. Here are a few links that might be handy as you venture further into the CollateralXP API: