API Reference

Comprehensive documentation for the Matador API.

Getting Started with the API

The Matador API allows you to programmatically access your trading data, create and manage algorithms, and execute trades. This reference provides comprehensive documentation for all available endpoints.

Authentication

All API requests require authentication using an API key. You can generate an API key in your account settings.

Base URL

All API requests should be made to the following base URL:

https://api.matador.com/v1

API Endpoints

GET/algorithms

List Algorithms

Returns a list of all algorithms in your account.

Parameters

Name	Type	Description
status	string	Filter by algorithm status (active, paused, draft)
limit	integer	Maximum number of results to return (default: 20)

Example Response

{
  "data": [
    {
      "id": "algo_123456",
      "name": "Moving Average Crossover",
      "description": "Simple MA crossover strategy",
      "status": "active",
      "created_at": "2025-03-01T12:00:00Z",
      "updated_at": "2025-03-15T09:30:00Z"
    },
    {
      "id": "algo_789012",
      "name": "RSI Mean Reversion",
      "description": "Mean reversion strategy based on RSI",
      "status": "paused",
      "created_at": "2025-02-15T10:00:00Z",
      "updated_at": "2025-03-10T14:45:00Z"
    }
  ],
  "meta": {
    "total": 2,
    "page": 1,
    "limit": 20
  }
}

POST/algorithms

Create Algorithm

Creates a new trading algorithm.

Request Body

Name	Type	Description
name	string	Name of the algorithm
description	string	Description of the algorithm
code	string	Algorithm code
parameters	object	Algorithm parameters

Example Request

{
  "name": "Moving Average Crossover",
  "description": "Simple MA crossover strategy",
  "code": "function onTick(data) { ... }",
  "parameters": {
    "shortPeriod": 10,
    "longPeriod": 50,
    "symbol": "AAPL"
  }
}

Need More Information?

This is just a sample of the available API endpoints. For the complete API documentation, including all endpoints, parameters, and response formats, please refer to our detailed developer guide.