policy/{id}

Retrieves a sponsorship policy by its unique ID.

GET /policy/{id}

policy/{id}

cURL

curl --request GET \
  --url https://rpc.etherspot.io/paymaster/policy/{id}

200

{
  "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": {
    "id": "policy_id_here"
  }
}

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"
}

Path Parameters

id · integer · required

The ID of the policy to retrieve.

Query Parameters

apiKey · string

Arka API key

Response

200

application/json

Successful operation

createdAt · string<date-time>

updatedAt · string<date-time>

id · integer

walletAddress · string

name · string

description · string

isPublic · boolean

isEnabled · boolean

isApplicableToAllNetworks · boolean

enabledChains · integer[]

supportedEPVersions · string[]

isPerpetual · boolean

startTime · string<date-time>

endTime · string<date-time>

globalMaximumApplicable · boolean

globalMaximumUsd · string

globalMaximumNative · string

globalMaximumOpCount · integer

perUserMaximumApplicable · boolean

perUserMaximumUsd · string

perUserMaximumNative · string

perUserMaximumOpCount · integer

perOpMaximumApplicable · boolean

perOpMaximumUsd · string

perOpMaximumNative · string

addressAllowList · string[] | null

addressBlockList · string[] | null