Getting Started with Fractio API

Introduction

Welcome to the Fractio API! This tutorial will guide you through the basics of using our API, including authentication, making your first API call, and understanding the response format.

1. Authentication

Before you can start using the Fractio API, you need to obtain an API key. If you haven't already, sign up for a Fractio account and generate your API key from the developer dashboard.

Note: Keep your API key secure and never share it publicly.

Using Your API Key

Include your API key in the header of each request you make to the Fractio API. Here's an example using cURL: 

curl -H "Authorization: Bearer YOUR_API_KEY" https://api.fractio.com/v1/properties

2. Making Your First API Call

Let's start by making a simple API call to retrieve a list of properties. We'll use the /properties endpoint for this example.

Try It Out

Replace YOUR_API_KEY with your actual API key and run the following command: 

curl -H "Authorization: Bearer YOUR_API_KEY" https://api.fractio.com/v1/properties

3. Understanding the Response

The API will return a JSON response. Here's an example of what you might receive: 

{
  "properties": [
    {
      "id": "prop_123456",
      "address": "123 Main St, Anytown, USA",
      "type": "residential",
      "value": 250000,
      "fractions_available": 100
    },
    {
      "id": "prop_789012",
      "address": "456 Oak Ave, Another City, USA",
      "type": "commercial",
      "value": 1000000,
      "fractions_available": 1000
    }
  ],
  "total": 2,
  "page": 1,
  "per_page": 10
}

This response includes an array of property objects, each with details like ID, address, type, value, and available fractions. The response also includes pagination information.

Next Steps

Now that you've made your first API call, you're ready to explore more of what the Fractio API has to offer. Check out these resources: