# Screen pools (Premium)

> For the complete documentation index, see [llms.txt](/docs/llms.txt).

POST https://api.g.alchemy.com/trading/v1/{apiKey}/premium/pools/screener

**Private preview:** Paths, parameters, response fields, and tier names are provisional.

**Compute units:** 700 (proposed; pending validation).

Screen pools on the selected network. Additional filter controls remain pending.

Use pageKey until it is null.

tokenAddress identifies the token that priceUsd refers to.

Reference: https://www.alchemy.com/docs/data/trading-api/endpoints/discovery/screen-pools-premium

## Path Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| apiKey | string | Yes |  |

## Code Examples

### cURL

```bash
curl --request POST \
  --url https://api.g.alchemy.com/trading/v1/docs-demo/premium/pools/screener \
  --header 'Content-Type: application/json' \
  --data '{
  "network": "eth-mainnet",
  "pageSize": 25
}'
```

### JavaScript

```javascript
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({network: 'eth-mainnet', pageSize: 25})
};

fetch('https://api.g.alchemy.com/trading/v1/docs-demo/premium/pools/screener', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.g.alchemy.com/trading/v1/docs-demo/premium/pools/screener"

payload = {
    "network": "eth-mainnet",
    "pageSize": 25
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

### Go

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.g.alchemy.com/trading/v1/docs-demo/premium/pools/screener"

	payload := strings.NewReader("{\n  \"network\": \"eth-mainnet\",\n  \"pageSize\": 25\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

### Java

```java
HttpResponse<String> response = Unirest.post("https://api.g.alchemy.com/trading/v1/docs-demo/premium/pools/screener")
  .header("Content-Type", "application/json")
  .body("{\n  \"network\": \"eth-mainnet\",\n  \"pageSize\": 25\n}")
  .asString();
```

### C#

```csharp
using RestSharp;


var options = new RestClientOptions("https://api.g.alchemy.com/trading/v1/docs-demo/premium/pools/screener");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"network\": \"eth-mainnet\",\n  \"pageSize\": 25\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

```


## Operation Specification

```yaml
path: /{apiKey}/premium/pools/screener
method: POST
operation:
  summary: Screen pools (Premium)
  operationId: screen-pools-premium
  tags:
    - Discovery
  x-shape-pending: true
  description: |-
    **Private preview:** Paths, parameters, response fields, and tier names are provisional.

    **Compute units:** 700 (proposed; pending validation).

    Screen pools on the selected network. Additional filter controls remain pending.

    Use pageKey until it is null.

    tokenAddress identifies the token that priceUsd refers to.
  parameters:
    - name: apiKey
      in: path
      required: true
      schema:
        type: string
        default: docs-demo
        description: For higher throughput, [create your own API key](https://dashboard.alchemy.com/signup)
  responses:
    '200':
      description: Successful response.
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: array
                items:
                  type: object
                  properties:
                    network:
                      description: Alchemy network slug.
                      x-shape-pending: true
                      type: string
                      enum:
                        - eth-mainnet
                        - base-mainnet
                        - arb-mainnet
                        - bnb-mainnet
                        - solana-mainnet
                        - opt-mainnet
                        - matic-mainnet
                        - avax-mainnet
                        - linea-mainnet
                        - hyperliquid-mainnet
                        - robinhood-mainnet
                        - arc-mainnet
                        - tempo-mainnet
                    poolAddress:
                      type: string
                      description: Pool address or pool identifier.
                      x-shape-pending: true
                    name:
                      type: string
                      description: Human-readable pool name.
                      x-shape-pending: true
                    priceUsd:
                      type:
                        - string
                        - 'null'
                      pattern: ^-?[0-9]+(\.[0-9]+)?$
                      description: Price of the selected token in USD. Decimal string; null means unknown.
                      x-shape-pending: true
                    liquidityUsd:
                      type:
                        - string
                        - 'null'
                      pattern: ^-?[0-9]+(\.[0-9]+)?$
                      description: Pool liquidity in USD. Decimal string; null means unknown.
                      x-shape-pending: true
                    volumeUsd:
                      type:
                        - string
                        - 'null'
                      pattern: ^-?[0-9]+(\.[0-9]+)?$
                      description: Trading volume over the last 24 hours, in USD. Decimal string; null means unknown.
                      x-shape-pending: true
                    createdAt:
                      type:
                        - string
                        - 'null'
                      format: date-time
                      description: ISO 8601 UTC timestamp; null means unknown.
                      x-shape-pending: true
                    tokenAddress:
                      type: string
                      description: Token address that defines price and trade direction in this row.
                      x-shape-pending: true
                    dexName:
                      type: string
                      description: Human-readable DEX name, when available.
                      x-shape-pending: true
                    feePercent:
                      type: string
                      description: Pool fee as a percentage, expressed as a decimal string.
                      x-shape-pending: true
                    buys:
                      type: integer
                      minimum: 0
                      description: Number of buys in the last 24 hours.
                      x-shape-pending: true
                    sells:
                      type: integer
                      minimum: 0
                      description: Number of sells in the last 24 hours.
                      x-shape-pending: true
                  required:
                    - network
                    - poolAddress
                x-shape-pending: true
              pageKey:
                type:
                  - string
                  - 'null'
                description: Opaque continuation key. Pass it unchanged to the next request; null marks the last page.
                x-shape-pending: true
            required:
              - data
              - pageKey
          example:
            data:
              - network: eth-mainnet
                poolAddress: '0xa43fe16908251ee70ef74718545e4fe6c5ccec9f'
                priceUsd: '0.000004984054101869709'
                liquidityUsd: '15775502.919737414'
                volumeUsd: '99905342.63553077'
                createdAt: '2023-04-14T17:21:11Z'
                tokenAddress: '0x6982508145454ce325ddbe47a25d4ec3d2311933'
                buys: 2249
                sells: 1708
                dexName: Uniswap V2
              - network: eth-mainnet
                poolAddress: '0xa6cc3c2531fdaa6ae1a3ca84c2855806728693e8'
                priceUsd: '11.02443163548515'
                liquidityUsd: '4567346.738898188'
                volumeUsd: '85326596.23232335'
                createdAt: '2021-05-05T17:50:38Z'
                tokenAddress: '0x514910771af9ca656af840dff83e8264ecf986ca'
                buys: 1116
                sells: 472
                dexName: Uniswap V3
            pageKey: null
    '400':
      description: Invalid request parameters.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  message:
                    type: string
                    description: Detailed error message.
                    x-shape-pending: true
                required:
                  - message
                x-shape-pending: true
            required:
              - error
          example:
            error:
              message: Invalid request parameters.
    '401':
      description: Invalid API key.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  message:
                    type: string
                    description: Detailed error message.
                    x-shape-pending: true
                required:
                  - message
                x-shape-pending: true
            required:
              - error
          example:
            error:
              message: Invalid API key.
    '429':
      description: Request limit reached. Retry with backoff.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  message:
                    type: string
                    description: Detailed error message.
                    x-shape-pending: true
                required:
                  - message
                x-shape-pending: true
            required:
              - error
          example:
            error:
              message: Request limit reached. Retry with backoff.
    '503':
      description: Data temporarily unavailable. Retry with backoff.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  message:
                    type: string
                    description: Detailed error message.
                    x-shape-pending: true
                required:
                  - message
                x-shape-pending: true
            required:
              - error
          example:
            error:
              message: Data temporarily unavailable. Retry with backoff.
  requestBody:
    required: true
    content:
      application/json:
        schema:
          type: object
          required:
            - network
          properties:
            network:
              x-shape-pending: true
              type: string
              enum:
                - eth-mainnet
                - base-mainnet
                - arb-mainnet
                - bnb-mainnet
                - avax-mainnet
                - robinhood-mainnet
                - arc-mainnet
                - solana-mainnet
                - tempo-mainnet
                - hyperliquid-mainnet
            pageSize:
              type: integer
              minimum: 1
              maximum: 100
              default: 25
              x-shape-pending: true
            pageKey:
              type: string
              description: Opaque key from the previous response; omit on the first request.
              x-shape-pending: true
        example:
          network: eth-mainnet
          pageSize: 25
```
