> For the complete documentation index, see [llms.txt](https://tri.gitbook.io/tri-doc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tri.gitbook.io/tri-doc/liquidity-pool/get-pool-list.md).

# Get Pool List

### Liquidity Pool

<mark style="color:blue;">`GET`</mark> <https://sandbox.triangle.digital/api/v2/liquidity\\_pool/pool\\_list>

Carbon pool records available for purchase, one entry per expense type of a record, cheapest first. The whole list is returned in one answer, up to 5000 rows. Amounts are objects with an ISO 4217 currency and a decimal-string amount.

**Headers**

<table data-full-width="true"><thead><tr><th>Name</th><th>Value</th></tr></thead><tbody><tr><td>Content-Type</td><td><code>application/json</code></td></tr></tbody></table>

**Query parameters**

<table data-full-width="true" data-search="false"><thead><tr><th width="220">Name</th><th width="110">Type</th><th>Description</th><th width="260">Example</th></tr></thead><tbody><tr><td><code>hash</code></td><td>string</td><td><strong>Required.</strong> API key.</td><td>fk5f0iuy-rr06-j4x3-i75b-fy2s67s4ilo1</td></tr><tr><td><code>carbon_type</code></td><td>string</td><td>Filter by expense type. Allowed values: AI Compute, Air Travel, Vehicle, Lodging, Food.</td><td>Air Travel</td></tr><tr><td><code>search</code></td><td>string</td><td>Free-text case-insensitive search by expense type.</td><td>Vehicle</td></tr></tbody></table>

**Response fields**

A row carries the fields of a purchased line in [Buy Carbon Pool](/tri-doc/liquidity-pool/buy-carbon-pool.md) that a catalogue can answer. What belongs to a purchase — the transaction, the retirement, the payment and the payer — is not part of a catalogue row.

<table data-full-width="true" data-search="false"><thead><tr><th width="360">Field</th><th width="110">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>message</code></td><td>string</td><td>Human-readable result of the call.</td></tr><tr><td><code>success</code></td><td>boolean</td><td>Whether the call succeeded; a failed call answers HTTP 400.</td></tr><tr><td><code>data.pools[].record_id</code></td><td>integer</td><td>Pool record. Pass it to <a href="/tri-doc/liquidity-pool/buy-carbon-pool.md">Buy Carbon Pool</a> together with <code>carbon_type</code> (Expense Type).</td></tr><tr><td><code>data.pools[].asset_name</code></td><td>string</td><td>Asset the credits would be bought from, under its current name.</td></tr><tr><td><code>data.pools[].asset_id</code></td><td>string</td><td>Identifier of that asset — 32 uppercase hexadecimal characters. It is the stable half of the pair: <code>asset_name</code> is the asset's CURRENT name and changes when the asset is renamed, while this value does not. The same identifier is answered for the line by <a href="/tri-doc/liquidity-pool/buy-carbon-pool.md">Buy Carbon Pool</a> and <a href="/tri-doc/liquidity-pool/get-carbon-transactions.md">Get Carbon Transactions</a>, so a purchase can be tied back to the asset it came from.</td></tr><tr><td><code>data.pools[].viewer</code></td><td>string</td><td>Address of the asset's Parameters Viewer — the page holding the parameters of that asset. <code>null</code> when the asset has no such page: only a Carbon Credit asset has one.</td></tr><tr><td><code>data.pools[].instrument_type</code></td><td>string</td><td>Instrument Type of that asset, as it is set on the asset now. An asset may carry several; they come back in one string, comma-separated — for example <code>Engineered, Nature-based</code>. <code>null</code> when the asset carries none.</td></tr><tr><td><code>data.pools[].carbon_type</code></td><td>string</td><td>Expense Type. One of: AI Compute, Air Travel, Vehicle, Lodging or Food. A record spanning several expense types appears once per type.</td></tr><tr><td><code>data.pools[].co2</code></td><td>number</td><td>Quantity available for purchase, tons of CO2e.</td></tr><tr><td><code>data.pools[].pool_px</code></td><td>object</td><td>Price per ton — currency and decimal string.</td></tr><tr><td><code>data.pools[].notional</code></td><td>object</td><td>Total of the row — <code>co2</code> × <code>pool_px</code>, currency and decimal string.</td></tr><tr><td><code>operations_count</code></td><td>integer</td><td>Always <code>1</code>.</td></tr></tbody></table>

**Response**

{% tabs %}
{% tab title="200" %}
{% code fullWidth="false" %}

```json
{
    "message": "Data received successfully.",
    "success": true,
    "data": {
        "pools": [
            {
                "record_id": 5241,
                "asset_name": "Walker Ranch UAT 2",
                "asset_id": "D689021E04987FB9476852972D0AE958",
                "viewer": "https://sandbox.triangle.digital/v/16924",
                "instrument_type": "Nature-based",
                "carbon_type": "Air Travel",
                "co2": 14706.0,
                "pool_px": { "currency": "USD", "amount": "12.12" },
                "notional": { "currency": "USD", "amount": "178236.72" }
            },
            {
                "record_id": 5241,
                "asset_name": "Walker Ranch UAT 2",
                "asset_id": "D689021E04987FB9476852972D0AE958",
                "viewer": "https://sandbox.triangle.digital/v/16924",
                "instrument_type": "Nature-based",
                "carbon_type": "Vehicle",
                "co2": 14706.0,
                "pool_px": { "currency": "USD", "amount": "12.12" },
                "notional": { "currency": "USD", "amount": "178236.72" }
            },
            {
                "record_id": 5115,
                "asset_name": "Climate Capital Asset",
                "asset_id": "4B81D6CA57F2490E8AD3C1F70B95E2D6",
                "viewer": "https://sandbox.triangle.digital/v/16938",
                "instrument_type": "Engineered, Nature-based",
                "carbon_type": "Food",
                "co2": 5000.0,
                "pool_px": { "currency": "USD", "amount": "12.12" },
                "notional": { "currency": "USD", "amount": "60600.00" }
            }
        ]
    },
    "operations_count": 1
}
```

{% endcode %}
{% endtab %}

{% tab title="400" %}
The hash is unknown or missing; the message says what exactly.

```json
{
    "message": "Error! No such hash.",
    "success": false
}
```

{% endtab %}
{% endtabs %}