Retrieve All Statistics

GET 
/statistics

Fetches all metrics on all disbursements the organization has created. The response includes basic aggregations on payments, receivers, receiver wallets, and assets.

Responses

200

General Statistics response

application/json

Schema

Schema

total_disbursementsint64
Total number of disbursements
Example: 20
payment_counters object
draftint64
Example: 1
readyint64
Example: 2
pendingint64
Example: 3
pausedint64
Example: 1
successint64
Example: 5
failedint64
Example: 1
totalint64
Example: 14
payment_amounts_by_asset object[]
Array [
asset_codestring
Example: USDC
payment_amounts object
draftstring
Example: 100.00
readystring
Example: 200.00
pendingstring
Example: 300.00
pausedstring
Example: 100.00
successstring
Example: 500.00
failedstring
Example: 100.00
averagestring
Example: 100.00
totalstring
Example: 1400.00
]
receiver_wallets_counters object
draftint64
Example: 1
readyint64
Example: 1
registeredint64
Example: 1
flaggedint64
Example: 1
totalint64
Example: 4
total_receiversint64
Total number of receivers
Example: 1000

Example (auto)

{
  "total_disbursements": 20,
  "payment_counters": {
    "draft": 1,
    "ready": 2,
    "pending": 3,
    "paused": 1,
    "success": 5,
    "failed": 1,
    "total": 14
  },
  "payment_amounts_by_asset": [
    {
      "asset_code": "USDC",
      "payment_amounts": {
        "draft": "100.00",
        "ready": "200.00",
        "pending": "300.00",
        "paused": "100.00",
        "success": "500.00",
        "failed": "100.00",
        "average": "100.00",
        "total": "1400.00"
      }
    }
  ],
  "receiver_wallets_counters": {
    "draft": 1,
    "ready": 1,
    "registered": 1,
    "flagged": 1,
    "total": 4
  },
  "total_receivers": 1000
}

401

Unauthorized

application/json

Schema

Schema

errorstring
extras object
statusnumber
messagestring

Example (auto)

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

Example

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

Authorization: Authorization

name: Authorizationtype: apiKeydescription: JWT used for authentication, signed with an ES256 private key.in: header

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://developers.stellar.org/statistics");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "<Authorization>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

Auth

BearerAuth

ResponseClear

Click the Send API Request button above and see the response here!