TruBase API Documentation
This documentation is for developers looking to integrate with TruBase's Partner API.
Authentication
Overview
Base URL
https://trubase-api.rg-infra.com/api
All paths above should be appended to the url above.
Authentication is required for all requests made to TruBase. You will need to include your API key in the request headers.
API Key
The TruBase uses token-based authentication. You will need to include your API key in the request headers.
Here's an example of how to obtain a token for use with the Partner API.
Bash
#!/bin/bash
curl -X POST \
-H "Content-Type: application/json" \
-d '{"username": "your_username", "password": "your_password"}' \
https://trubase-api.rg-infra.com/api/token/
Partner API
Overview
The Partner API is used to access data from TruBase's database. This includes information about agents, listings, locations, and stats.
Requests to the Partner API should include your API key in the request headers.
The Partner API has the following endpoints:
Error Responses
Overview
Here are the error responses that you can receive.
Status | When | Body |
---|---|---|
401 Not Authorized | Authorization header is missing or incorrect, or the given credentials doesn't have permission for this site | {"error":"description"} |
400 Bad Request | Request body doesn’t contain a valid JSON document | {"error":"description"} |
422 Unprocessable Entity | Request body has valid JSON document but one of the fields did not validate | {"error":"description"} |
500 Internal Server Error | Unknown error | Unspecified |
503 Service Unavailable | API server is not responding | Unspecified |