---
title: "Every endpoint: its price, parameters and what it returns"
method: GET
path: "/endpoints"
tags: ["Catalogue"]
---

# Every endpoint: its price, parameters and what it returns

`GET /endpoints`

## Request

- Base URL: `https://api.scrapefield.com/v1`
- URL: `https://api.scrapefield.com/v1/endpoints`
- Auth: none required

## Response `200`

The endpoint table.

- object
  - `data` object[], required
    - `endpoint` string
    - `surface` string
    - `summary` string
    - `available` boolean: Whether a call can be served now: false for an endpoint not offered yet, and for one that cannot be served this minute, as `/v1/status` shows.
    - `unavailable_because` string: Why it is not available, when it is not.
    - `credits` integer
    - `credits_by` object
      - `parameter` string
      - `credits` object
    - `returns` string
    - `list` boolean
    - `cache_ttl_seconds` integer
    - `parameters` object[]

---

[API](https://skmtc.dev/scrapefield/apis/scrapefield-api.md) · [All operations](https://skmtc.dev/scrapefield/apis/scrapefield-api/llms.txt) · [OpenAPI document](https://skmtc.dev/scrapefield/apis/scrapefield-api/revisions/cc5961ac63cf?raw)