Search payments

post

https://api.tryspeed.com/search/payments

Use this endpoint along with Speed’s Search Query Language to look up previously created payments.

This API returns results only for the past 90 days. Any search queries before this period will not retrieve data. Please adjust your filters accordingly.

Body Params

query

string

required

Defaults to amount>120 status:paid metadata['key_1']:value_1

In this parameter write the query clause according to Speed's query language. Make sure to check the list of query fields supported for payments.

limit

int32

A limit specifies the number of objects to be returned. The default page size has 10 objects per page, and it is consistent across endpoints.

page

string

A cursor to navigate between pages of results. For the initial call, omit this parameter. Use the next_page value returned in a previous response to request subsequent results.

Headers

speed-version

string

enum

Defaults to 2022-04-15

In this parameter, you can specify the version you want. As of now, there are two versions (2022-04-15 and 2022-10-15). Version 2022-10-15 supports on-chain, lightning, Ethereum, Tron and Solana payment methods. Whereas the 2022-04-15 version only supports lightning payments.

Allowed:

Response

Language

Credentials

Basic

base64

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200