# Blockscout Developer Portal

> Blockscout Developer Portal provides access to Blockscout PRO API — an enhanced API service
> with higher call limits for Blockscout-hosted blockchain networks.

## Access

- Registration and API key management: https://dev.blockscout.com
- API key format: `proapi_xxxxxxxx`
- Authentication: query parameter `apikey` or header `authorization`

## Plans

To get current plan details (pricing, rate limits, credits), call the plans API:

```
curl https://api.blockscout.com/api/json/plans
```

To check current balance and credits spent, call the user profile API:

```
curl https://api.blockscout.com/api/json/users/me
```

Note: both endpoints require authorization on the developer portal (https://dev.blockscout.com).

### Enterprise Custom
- Custom pricing
- Improved SLA
- Personal support
- Scaling and reporting

## API Channels

### ETH RPC API
- Endpoint: `base_url/:chain_id/json-rpc`
- Matches standard JSON RPC available on Ethereum Nodes
- [Documentation](https://docs.blockscout.com/devs/apis/rpc/eth-rpc.md)

### JSON RPC API
- Endpoint: `base_url/v2/api?chain_id=:chain_id` or `base_url/:chain_id/api`
- Query format: `?module=[MODULE]&action=[ACTION]&[parameters]`
- [Documentation](https://docs.blockscout.com/devs/apis/rpc.md)
- Modules: [Account](https://docs.blockscout.com/devs/apis/rpc/account.md), [Block](https://docs.blockscout.com/devs/apis/rpc/block.md), [Contract](https://docs.blockscout.com/devs/apis/rpc/contract.md), [Logs](https://docs.blockscout.com/devs/apis/rpc/logs.md), [Stats](https://docs.blockscout.com/devs/apis/rpc/stats.md), [Token](https://docs.blockscout.com/devs/apis/rpc/token.md), [Transaction](https://docs.blockscout.com/devs/apis/rpc/transaction.md)

### REST API
- Endpoint: `base_url/:chain_id/api/v2`
- [Documentation](https://docs.blockscout.com/devs/apis/rest.md)
- The source of truth for REST API endpoints is the swagger file: [default/swagger.yaml](https://github.com/blockscout/swaggers/blob/master/blockscout/master/default/swagger.yaml)
- For different types of sidechains or rollups there are swagger files enriched with chain-specific information (additional fields or additional endpoints): [swaggers/blockscout/master](https://github.com/blockscout/swaggers/tree/master/blockscout/master)
  - e.g. [arbitrum](https://github.com/blockscout/swaggers/blob/master/blockscout/master/arbitrum/swagger.yaml), [rsk](https://github.com/blockscout/swaggers/blob/master/blockscout/master/rsk/swagger.yaml), [mud](https://github.com/blockscout/swaggers/blob/master/blockscout/master/mud/swagger.yaml)

## Documentation

- [Blockscout Developer Portal](https://dev.blockscout.com): Registration, API key management, usage statistics
- [PRO API Overview](https://docs.blockscout.com/devs/pro-api.md): PRO API documentation
- [API Documentation](https://docs.blockscout.com/devs/apis): Comprehensive API guides
- [ETH RPC API](https://docs.blockscout.com/devs/apis/rpc/eth-rpc.md): Standard Ethereum JSON-RPC methods
- [JSON RPC API](https://docs.blockscout.com/devs/apis/rpc.md): Blockscout JSON RPC with modules
- [REST API](https://docs.blockscout.com/devs/apis/rest.md): RESTful API endpoints
- [OpenAPI Specifications](https://github.com/blockscout/swaggers/tree/master/blockscout/master): Swagger files for all chain types

## Optional

- [Account Module](https://docs.blockscout.com/devs/apis/rpc/account.md): Account-related RPC methods
- [Block Module](https://docs.blockscout.com/devs/apis/rpc/block.md): Block data RPC methods
- [Contract Module](https://docs.blockscout.com/devs/apis/rpc/contract.md): Smart contract RPC methods
- [Logs Module](https://docs.blockscout.com/devs/apis/rpc/logs.md): Event logs RPC methods
- [Stats Module](https://docs.blockscout.com/devs/apis/rpc/stats.md): Statistics RPC methods
- [Token Module](https://docs.blockscout.com/devs/apis/rpc/token.md): Token data RPC methods
- [Transaction Module](https://docs.blockscout.com/devs/apis/rpc/transaction.md): Transaction RPC methods