# GOAT Network API
> Live GOAT Network on-chain data via Blockscout. GOAT Network is a Bitcoin-staking Layer 2; gas and balances are in BTC. Network stats, gas prices, latest blocks, a block by height or hash, address detail with BTC balance, a transaction by hash, ERC-20 token metadata and a universal search across addresses, tokens, blocks and transactions. Real data, no key.

## Authentication
All requests require your oanor API key in the `x-oanor-key` header. Get one at https://www.oanor.com/developer/keys.

```bash
curl -H "x-oanor-key: oanor_live_…" "https://api.oanor.com/goat-api/..."
```

## Pricing
- **Free** (Free) — 1,750 calls/Mo, 1 req/s
- **Basic** ($12/Mo) — 71,500 calls/Mo, 10 req/s
- **Pro** ($39/Mo) — 515,500 calls/Mo, 20 req/s
- **Mega** ($123/Mo) — 2,630,500 calls/Mo, 50 req/s

## Endpoints

### Network

#### `GET /v1/gas` — Current gas prices

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/goat-api/v1/gas"
```

#### `GET /v1/stats` — Network statistics

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/goat-api/v1/stats"
```

### Blocks

#### `GET /v1/block` — A block by height or hash

**Parameters:**
- `height` (query, optional, string) — Block height Example: `12919634`
- `hash` (query, optional, string) — Block hash

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/goat-api/v1/block?height=12919634"
```

#### `GET /v1/blocks` — Latest blocks

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/goat-api/v1/blocks"
```

### Accounts

#### `GET /v1/address` — Address detail with BTC balance

**Parameters:**
- `address` (query, required, string) — Address hash Example: `0x3022b87ac063DE95b1570F46f5e470F8B53112D8`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/goat-api/v1/address?address=0x3022b87ac063DE95b1570F46f5e470F8B53112D8"
```

### Transactions

#### `GET /v1/transaction` — A transaction by hash

**Parameters:**
- `hash` (query, required, string) — Transaction hash Example: `0x8da6b62132615bdecd207bc1b7b72dc0a09c43ddaf4e4df67a027fcae0be2d79`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/goat-api/v1/transaction?hash=0x8da6b62132615bdecd207bc1b7b72dc0a09c43ddaf4e4df67a027fcae0be2d79"
```

### Tokens

#### `GET /v1/token` — ERC-20 token metadata

**Parameters:**
- `address` (query, required, string) — Token contract address Example: `0x3022b87ac063DE95b1570F46f5e470F8B53112D8`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/goat-api/v1/token?address=0x3022b87ac063DE95b1570F46f5e470F8B53112D8"
```

### Search

#### `GET /v1/search` — Universal on-chain search

**Parameters:**
- `q` (query, required, string) — Address, token, block or tx Example: `USD`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/goat-api/v1/search?q=USD"
```

### Meta

#### `GET /v1/meta` — Service metadata

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/goat-api/v1/meta"
```


---
Marketplace page: https://www.oanor.com/api/goat-api
OpenAPI spec: https://www.oanor.com/api/goat-api/openapi.json
