Arka API calls
/policy/walletAddress/{walletAddress}/epVersion/{epVersion}/chainId/{chainId}
Arka Paymaster
- Introduction to Arka
- Deposit to Arka
- Sponsor A Transaction
- Arka testnet Usage
- Pay for gas with ERC20 tokens using MultiTokenPaymaster
- Arka API calls
- POSTpm_getERC20TokenQuotes
- POSTpm_sponsorUserOperation
- POST/checkWhitelist
- POST/checkWhitelist/v2
- POST/whitelist
- POST/whitelist/v2
- POST/removeWhitelist
- POST/removeWhitelist/v2
- POST/deposit
- POST/deposit/v2
- POST/getAllCommonERC20PaymasterAddress
- POST/getAllWhitelist/v2
- GET/metadata
- GET/metadata/v2
- POST/addPolicy
- DEL/deletePolicy/{id}
- PUT/updatePolicy
- PUT/enablePolicy/{id}
- PUT/disablePolicy/{id}
- GET/policy
- GET/policy/{id}
- GET/policy/walletAddress/{walletAddress}
- GET/policy/walletAddress/{walletAddress}/epVersion/{epVersion}
- GET/policy/walletAddress/{walletAddress}/epVersion/{epVersion}/chainId/{chainId}
- GET/policy/walletAddress/{walletAddress}/latest
- GET/policy/walletAddress/{walletAddress}/epVersion/{epVersion}/latest
- GET/policy/walletAddress/{walletAddress}/chainId/{chainId}/latest
- GET/policy/walletAddress/{walletAddress}/epVersion/{epVersion}/chainId/{chainId}/latest
- POST
Arka API calls
/policy/walletAddress/{walletAddress}/epVersion/{epVersion}/chainId/{chainId}
Retrieves all sponsorship policies for a given wallet address, EP version, and chain ID.
GET
/
policy
/
walletAddress
/
{walletAddress}
/
epVersion
/
{epVersion}
/
chainId
/
{chainId}
curl --request GET \
--url https://rpc.etherspot.io/paymaster/policy/walletAddress/{walletAddress}/epVersion/{epVersion}/chainId/{chainId}
[
{
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"id": 123,
"walletAddress": "<string>",
"name": "<string>",
"description": "<string>",
"isPublic": true,
"isEnabled": true,
"isApplicableToAllNetworks": true,
"enabledChains": [
123
],
"supportedEPVersions": [
"<string>"
],
"isPerpetual": true,
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"globalMaximumApplicable": true,
"globalMaximumUsd": "<string>",
"globalMaximumNative": "<string>",
"globalMaximumOpCount": 123,
"perUserMaximumApplicable": true,
"perUserMaximumUsd": "<string>",
"perUserMaximumNative": "<string>",
"perUserMaximumOpCount": 123,
"perOpMaximumApplicable": true,
"perOpMaximumUsd": "<string>",
"perOpMaximumNative": "<string>",
"addressAllowList": [
"<string>"
],
"addressBlockList": [
"<string>"
]
}
]
Example values you can use to demo the API:
{
"pathVariables": {
"walletAddress": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8",
"epVersion": "EPV_07",
"chainId": 80002
}
}
Example response:
[
{
"id": 2,
"walletAddress": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8",
"name": "Sample Policy",
"description": "This is a sample policy",
"isPublic": true,
"isEnabled": true,
"isApplicableToAllNetworks": false,
"enabledChains": [
80002
],
"supportedEPVersions": [
"EPV_06",
"EPV_07"
],
"isPerpetual": false,
"startTime": "2024-06-24T00:40:00.000Z",
"endTime": "2024-06-25T23:59:59.999Z",
"globalMaximumApplicable": true,
"globalMaximumUsd": "5000.0000",
"globalMaximumNative": "1000.000000000000000000",
"globalMaximumOpCount": 1000,
"perUserMaximumApplicable": true,
"perUserMaximumUsd": "100.0000",
"perUserMaximumNative": "200.000000000000000000",
"perUserMaximumOpCount": 50,
"perOpMaximumApplicable": true,
"perOpMaximumUsd": "10.0000",
"perOpMaximumNative": "20.000000000000000000",
"addressAllowList": null,
"addressBlockList": null,
"createdAt": "2024-06-26T19:50:09.475Z",
"updatedAt": "2024-06-26T19:50:09.475Z"
},
{
"id": 1,
"walletAddress": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8",
"name": "Sample Policy",
"description": "This is a sample policy modified",
"isPublic": true,
"isEnabled": true,
"isApplicableToAllNetworks": false,
"enabledChains": [
80002
],
"supportedEPVersions": [
"EPV_06",
"EPV_07"
],
"isPerpetual": false,
"startTime": "2024-06-26T00:40:00.000Z",
"endTime": "2024-06-27T23:59:59.999Z",
"globalMaximumApplicable": true,
"globalMaximumUsd": "6000.0000",
"globalMaximumNative": "2000.000000000000000000",
"globalMaximumOpCount": 1000,
"perUserMaximumApplicable": true,
"perUserMaximumUsd": "100.0000",
"perUserMaximumNative": "200.000000000000000000",
"perUserMaximumOpCount": 50,
"perOpMaximumApplicable": true,
"perOpMaximumUsd": "10.0000",
"perOpMaximumNative": "20.000000000000000000",
"addressAllowList": null,
"addressBlockList": null,
"createdAt": "2024-06-26T19:49:08.252Z",
"updatedAt": "2024-06-27T19:38:39.674Z"
}
]
Path Parameters
The wallet address to find the policies for.
The EP version to find the policies for.
The chain ID to find the policies for.
Query Parameters
Arka API key
Response
200
application/json
Successful operation
The response is of type object[]
.
curl --request GET \
--url https://rpc.etherspot.io/paymaster/policy/walletAddress/{walletAddress}/epVersion/{epVersion}/chainId/{chainId}
[
{
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"id": 123,
"walletAddress": "<string>",
"name": "<string>",
"description": "<string>",
"isPublic": true,
"isEnabled": true,
"isApplicableToAllNetworks": true,
"enabledChains": [
123
],
"supportedEPVersions": [
"<string>"
],
"isPerpetual": true,
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"globalMaximumApplicable": true,
"globalMaximumUsd": "<string>",
"globalMaximumNative": "<string>",
"globalMaximumOpCount": 123,
"perUserMaximumApplicable": true,
"perUserMaximumUsd": "<string>",
"perUserMaximumNative": "<string>",
"perUserMaximumOpCount": 123,
"perOpMaximumApplicable": true,
"perOpMaximumUsd": "<string>",
"perOpMaximumNative": "<string>",
"addressAllowList": [
"<string>"
],
"addressBlockList": [
"<string>"
]
}
]