> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mindcase.co/llms.txt
> Use this file to discover all available pages before exploring further.

# GOAT Products API

> Full GOAT product detail (every size, its asking price and availability), one row per product, from a search, a brand page or a product URL.

`POST /v1/data/goat/products/run`

**Pricing:** $0.001 per product ($1.00 per 1,000).

## Ways to call it

* **Listing URL**: set `listing_url` (optional: `maxResults`, `country_code`)
* **Search**: set `query` (optional: `maxResults`, `country_code`)
* **Product URL**: set `urls` (optional: `country_code`)

## Request

Send the inputs under `params`. Only the keys below are accepted; any other key returns `422 invalid_params`.

**listing\_url** `string`

A GOAT listing page URL: a brand page ([https://www.goat.com/brand/salomon](https://www.goat.com/brand/salomon)) or a search results page ([https://www.goat.com/search?query=nike](https://www.goat.com/search?query=nike)). Brand pages return the full catalog; searches are relevance-ranked. Any GOAT filter in the URL is honoured.

Format e.g. `https://www.goat.com/brand/salomon`.

**query** `string`

A keyword to search GOAT for, e.g. 'jordan 1 chicago'. We build the search URL for you, so there's no need to paste one. Relevance-ranked, so it drops roughly 30-40% of a brand; use a brand page as the Listing URL for a full catalog.

**urls** `string[]`

One or more GOAT product URLs, e.g. [https://www.goat.com/sneakers/air-jordan-1-high-1985-4280](https://www.goat.com/sneakers/air-jordan-1-high-1985-4280). One per line.

**maxResults** `integer`

Number of products to return from a search or brand page. Use 0 for all. Ignored when you pass product URLs.

**country\_code** `string` (default: US)

Shopping region. Shapes which sellers and sizes are offered and their asking prices. Regions without their own market get GOAT's global pricing (the same listings as the default). Prices are quoted in USD regardless.

170 allowed values, for example `DZ` (Algeria), `AD` (Andorra), `AI` (Anguilla), `AG` (Antigua and Barbuda), `AR` (Argentina), `AM` (Armenia), `AW` (Aruba), `AU` (Australia), `AT` (Austria), `AZ` (Azerbaijan). Fetch the full list with `GET /v1/data/goat/products?expand=options`.

## Example

```bash cURL theme={null}
curl -X POST "https://api.mindcase.co/v1/data/goat/products/run?wait=true" \
  -H "Authorization: Bearer $MINDCASE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "params": {
    "listing_url": "https://www.goat.com/brand/salomon",
    "maxResults": 50
  }
}'
```

```python Python theme={null}
import os, requests

r = requests.post(
    "https://api.mindcase.co/v1/data/goat/products/run",
    params={"wait": "true"},
    headers={"Authorization": f"Bearer {os.environ['MINDCASE_API_KEY']}"},
    json={"params": {
    "listing_url": "https://www.goat.com/brand/salomon",
    "maxResults": 50
}},
)
job = r.json()
rows = job.get("data", [])  # if job["status"] == "running", poll /v1/jobs/{job_id}/results
```

```javascript Node.js theme={null}
const r = await fetch("https://api.mindcase.co/v1/data/goat/products/run?wait=true", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.MINDCASE_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ params: {
  "listing_url": "https://www.goat.com/brand/salomon",
  "maxResults": 50
} }),
});
const job = await r.json();
const rows = job.data ?? []; // if job.status === "running", poll /v1/jobs/{job_id}/results
```

## Response fields

Each row in `data` is one product, keyed by these fields.

| Field | Name | Type |
| - | - | - |
| `productId` | Product ID | number |
| `productName` | Product Name | text |
| `sku` | SKU | text |
| `productUrl` | Product URL | url |
| `brand` | Brand | text |
| `colorway` | Colorway | text |
| `color` | Color | text |
| `category` | Category | text |
| `subcategory` | Subcategory | text |
| `categoryLevel3` | Category Level 3 | text |
| `categoryLevel4` | Category Level 4 | text |
| `activities` | Activities | array |
| `gender` | Gender | text |
| `releaseDate` | Release Date | date |
| `season` | Season | text |
| `story` | Story | text |
| `styleTags` | Style Tags | array |
| `detailTags` | Detail Tags | array |
| `merchandisingTags` | Merchandising Tags | array |
| `specialType` | Special Type | text |
| `isResellable` | Is Resellable | boolean |
| `directShipping` | Direct Shipping | boolean |
| `maxOffer` | Max Offer | currency |
| `sizeType` | Size Type | text |
| `sizeUnit` | Size Unit | text |
| `retailPrice` | Retail Price | currency |
| `images` | Images | array |
| `attributes` | Attributes | object\_array |
| `listings` | Listings | object\_array |

## Example response

Abridged: long text and lists are shortened.

```json theme={null}
{
  "job_id": "7f3a1c2e-0b9d-4c55-9a51-3f2e8d1b6a40",
  "agent": "goat/products",
  "status": "completed",
  "row_count": 1,
  "truncated": false,
  "data": [
    {
      "sizeType": "numeric_sizes",
      "releaseDate": "2022-11-19",
      "listings": [
        {
          "size": "3.5",
          "sizeNumeric": 3.5,
          "shoeCondition": "New with Defects",
          "boxCondition": "Badly Damaged Box",
          "stockStatus": "Out of Stock",
          "lowestAsk": null,
          "instantShipAsk": null,
          "lastSold": 277.0
        },
        {
          "size": "3.5",
          "sizeNumeric": 3.5,
          "shoeCondition": "New",
          "boxCondition": "Badly Damaged Box",
          "stockStatus": "Out of Stock",
          "lowestAsk": null,
          "instantShipAsk": null,
          "lastSold": 287.0
        }
      ],
      "specialType": "standard",
      "productId": 920714,
      "images": [
        "https://image.goat.com/1000/attachments/product_template_pictures/images/080/963/035/original/920714_00.png.png",
        "https://image.goat.com/transform/v1/attachments/product_template_additional_pictures/images/080/963/037/original/920714_01.jpg.jpeg?action=crop&width=2000"
      ],
      "season": "2022",
      "attributes": [
        {
          "attribute": "Silhouette",
          "value": "Air Jordan 1"
        },
        {
          "attribute": "Nickname",
          "value": "Chicago Lost & Found"
        }
      ],
      "colorway": "Varsity Red/Black/Sail/Muslin",
      "brand": "Air Jordan",
      "detailTags": [
        "Air"
      ],
      "categoryLevel3": "Basketball",
      "merchandisingTags": [
        "POP COLORS: Primaries"
      ],
      "isResellable": true,
      "gender": "men",
      "sizeUnit": "us",
      "maxOffer": 2000.0,
      "story": "The Air Jordan 1 Retro High OG ‘Chicago Lost & Found’ brings back the iconic silhouette that started it all. Featuring the high-cut shape of the original 198...",
      "retailPrice": 180.0,
      "styleTags": [
        "La",
        "Streetwear"
      ],
      "category": "Footwear",
      "categoryLevel4": "Lifestyle Basketball",
      "directShipping": false,
      "color": "Red",
      "productName": "Air Jordan 1 Retro High OG 'Chicago Lost & Found'"
    }
  ]
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.