API product catalogInstitutional Reporting, Auditing & Compliance

Report — Revenue

Institutional Reporting, Auditing & Compliance

GET

/report/revenue

Report — Revenue

Sandbox availablelistRevenue

Returns your net revenue (markup fees) across all sub-accounts for the given period.

Parameters

fromstringquery

tostringquery

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

partnerKeystringRequired

markupBpsnumberRequired

periodobjectRequired

period.fromstring | nullRequired

period.tostring | nullRequired

currencyUSDRequired

totalRevenuenumberRequired

totalBaseFeesnumberRequired

tradeCountintegerRequired

monthlyobject[]Required

monthly[].monthstringRequired

monthly[].revenuenumberRequired

monthly[].baseFeesnumberRequired

monthly[].tradeCountintegerRequired

bySymbolobject[]Required

bySymbol[].symbolstringRequired

bySymbol[].revenuenumberRequired

bySymbol[].baseFeesnumberRequired

bySymbol[].tradeCountintegerRequired

transactionsobject[]Required

transactions[].idstringRequired

transactions[].orderIdstring

transactions[].symbolstring

transactions[].tradeTypestring

transactions[].markupFeenumberRequired

transactions[].baseFeenumberRequired

transactions[].totalFeenumber

transactions[].markupBpsnumber

transactions[].currencystringRequired

transactions[].createdAtstring | nullRequired

Response codes

200Revenue report.

Sandbox playground

Read-only sandbox request

from Optional · queryto Optional · querySandbox API keyYour key stays in this page’s memory.

https://mystocks.africa/api/sandbox/v1/partner/report/revenue

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "required": [
    "partnerKey",
    "markupBps",
    "period",
    "currency",
    "totalRevenue",
    "totalBaseFees",
    "tradeCount",
    "monthly",
    "bySymbol",
    "transactions"
  ],
  "properties": {
    "partnerKey": {
      "type": "string"
    },
    "markupBps": {
      "type": "number"
    },
    "period": {
      "type": "object",
      "required": [
        "from",
        "to"
      ],
      "properties": {
        "from": {
          "type": [
            "string",
            "null"
          ]
        },
        "to": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "currency": {
      "type": "string",
      "enum": [
        "USD"
      ]
    },
    "totalRevenue": {
      "type": "number"
    },
    "totalBaseFees": {
      "type": "number"
    },
    "tradeCount": {
      "type": "integer"
    },
    "monthly": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "month",
          "revenue",
          "baseFees",
          "tradeCount"
        ],
        "properties": {
          "month": {
            "type": "string"
          },
          "revenue": {
            "type": "number"
          },
          "baseFees": {
            "type": "number"
          },
          "tradeCount": {
            "type": "integer"
          }
        }
      }
    },
    "bySymbol": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "symbol",
          "revenue",
          "baseFees",
          "tradeCount"
        ],
        "properties": {
          "symbol": {
            "type": "string"
          },
          "revenue": {
            "type": "number"
          },
          "baseFees": {
            "type": "number"
          },
          "tradeCount": {
            "type": "integer"
          }
        }
      }
    },
    "transactions": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "markupFee",
          "baseFee",
          "currency",
          "createdAt"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "orderId": {
            "type": "string"
          },
          "symbol": {
            "type": "string"
          },
          "tradeType": {
            "type": "string"
          },
          "markupFee": {
            "type": "number"
          },
          "baseFee": {
            "type": "number"
          },
          "totalFee": {
            "type": "number"
          },
          "markupBps": {
            "type": "number"
          },
          "currency": {
            "type": "string"
          },
          "createdAt": {
            "type": [
              "string",
              "null"
            ]
          }
        }
      }
    }
  }
}

curl -X GET 'https://mystocks.africa/api/sandbox/v1/partner/report/revenue' \
  -H "Authorization: Bearer $MYSTOCKS_SANDBOX_API_KEY"

GET /report/reconciliation

GET /stream