*__name__*: Rpc

*__summary__*: The API may use a HTTP or WebSockets provider.

*__description__*: It allows for querying a Polkadot Client Node. WebSockets provider is recommended since HTTP provider only supports basic querying.

```mermaid
graph LR;
  A[Api] --> |WebSockets| B[WsProvider];
  B --> |endpoint| C[ws://127.0.0.1:9944]
```

*__example__*:   

```javascript
import Api from '@polkadot/rpc-core';
import WsProvider from '@polkadot/rpc-provider/ws';

const provider = new WsProvider('ws://127.0.0.1:9944');
const api = new Api(provider);
```

# Hierarchy

**Rpc**

# Implements

* [RpcInterface](../interfaces/_types_.rpcinterface.md)

# Constructors

<a id="constructor"></a>

##  constructor

⊕ **new Rpc**(provider?: *`ProviderInterface`*): [Rpc](_index_.rpc.md)

*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/695e4f2/packages/rpc-core/src/index.ts#L46)*

*__constructor__*: Default constructor for the Api Object

**Parameters:**

| Name | Type | Default value | Description |
| ------ | ------ | ------ | ------ |
| `Default value` provider | `ProviderInterface` |  new WsProvider() |  An API provider using HTTP or WebSocket |

**Returns:** [Rpc](_index_.rpc.md)

___

# Properties

<a id="_provider"></a>

##  _provider

**● _provider**: *`ProviderInterface`*

*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/695e4f2/packages/rpc-core/src/index.ts#L42)*

___
<a id="author"></a>

##  author

**● author**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*

*Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[author](../interfaces/_types_.rpcinterface.md#author)*

*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/695e4f2/packages/rpc-core/src/index.ts#L43)*

___
<a id="chain"></a>

##  chain

**● chain**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*

*Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[chain](../interfaces/_types_.rpcinterface.md#chain)*

*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/695e4f2/packages/rpc-core/src/index.ts#L44)*

___
<a id="state"></a>

##  state

**● state**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*

*Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[state](../interfaces/_types_.rpcinterface.md#state)*

*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/695e4f2/packages/rpc-core/src/index.ts#L45)*

___
<a id="system"></a>

##  system

**● system**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*

*Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[system](../interfaces/_types_.rpcinterface.md#system)*

*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/695e4f2/packages/rpc-core/src/index.ts#L46)*

___

# Methods

<a id="signature"></a>

## `<Static>` signature

▸ **signature**(__namedParameters: *`object`*): `string`

*Defined in [index.ts:79](https://github.com/polkadot-js/api/blob/695e4f2/packages/rpc-core/src/index.ts#L79)*

*__name__*: signature

*__summary__*: Returns a string representation of the method with inputs and outputs.

*__description__*: Formats the name, inputs and outputs into a human-readable string. This contains the input parameter names input types and output type.

*__example__*:   

```javascript
import Api from '@polkadot/rpc-core';

Api.signature({ name: 'test_method', params: [ { name: 'dest', type: 'Address' } ], type: 'Address' }); // => test_method (dest: Address): Address
```

**Parameters:**

| Name | Type |
| ------ | ------ |
| __namedParameters | `object` |

**Returns:** `string`

___