---
updatedAt: 2025-09-09T22:21:20.000Z
agentTools:
  projectIndex: https://apidocs.superform.xyz/llms.txt
---

# Get transaction for claiming rewards

Get transaction for claiming rewards for a user

# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "ClaimTransaction": {
        "additionalProperties": false,
        "properties": {
          "$schema": {
            "description": "A URL to the JSON Schema for this object.",
            "examples": [
              "https://api.superform.xyz/schemas/ClaimTransaction.json"
            ],
            "format": "uri",
            "readOnly": true,
            "type": "string"
          },
          "gasLimit": {
            "format": "int64",
            "type": "integer"
          },
          "to": {
            "type": "string"
          },
          "transactionData": {
            "type": "string"
          }
        },
        "required": [
          "transactionData",
          "to"
        ],
        "type": "object"
      },
      "ErrorDetail": {
        "additionalProperties": false,
        "properties": {
          "location": {
            "description": "Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'",
            "type": "string"
          },
          "message": {
            "description": "Error message text",
            "type": "string"
          },
          "value": {
            "description": "The value at the given location"
          }
        },
        "type": "object"
      },
      "ErrorModel": {
        "additionalProperties": false,
        "properties": {
          "$schema": {
            "description": "A URL to the JSON Schema for this object.",
            "examples": [
              "https://api.superform.xyz/schemas/ErrorModel.json"
            ],
            "format": "uri",
            "readOnly": true,
            "type": "string"
          },
          "detail": {
            "description": "A human-readable explanation specific to this occurrence of the problem.",
            "examples": [
              "Property foo is required but is missing."
            ],
            "type": "string"
          },
          "errors": {
            "description": "Optional list of individual error details",
            "items": {
              "$ref": "#/components/schemas/ErrorDetail"
            },
            "type": "array"
          },
          "instance": {
            "description": "A URI reference that identifies the specific occurrence of the problem.",
            "examples": [
              "https://example.com/error-log/abc123"
            ],
            "format": "uri",
            "type": "string"
          },
          "status": {
            "description": "HTTP status code",
            "examples": [
              400
            ],
            "format": "int64",
            "type": "integer"
          },
          "title": {
            "description": "A short, human-readable summary of the problem type. This value should not change between occurrences of the error.",
            "examples": [
              "Bad Request"
            ],
            "type": "string"
          },
          "type": {
            "default": "about:blank",
            "description": "A URI reference to human-readable documentation for the error.",
            "examples": [
              "https://example.com/errors/example"
            ],
            "format": "uri",
            "type": "string"
          }
        },
        "type": "object"
      }
    },
    "securitySchemes": {
      "apiKey": {
        "description": "Provide the api key issued to you",
        "in": "header",
        "name": "SF-API-KEY",
        "type": "apiKey"
      }
    }
  },
  "info": {
    "title": "Superform API",
    "version": "1.0.0"
  },
  "openapi": "3.1.0",
  "paths": {
    "/protocolRewards/claim/{chain_id}/{user}": {
      "get": {
        "description": "Get transaction for claiming rewards for a user",
        "operationId": "claim-rewards",
        "parameters": [
          {
            "example": "0x1234567890123456789012345678901234567890",
            "in": "path",
            "name": "user",
            "required": true,
            "schema": {
              "examples": [
                "0x1234567890123456789012345678901234567890"
              ],
              "type": "string"
            }
          },
          {
            "example": 1,
            "in": "path",
            "name": "chain_id",
            "required": true,
            "schema": {
              "examples": [
                1
              ],
              "format": "int64",
              "type": "integer"
            }
          },
          {
            "example": false,
            "explode": false,
            "in": "query",
            "name": "simulate_transaction",
            "schema": {
              "examples": [
                false
              ],
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClaimTransaction"
                }
              }
            },
            "description": "OK"
          },
          "default": {
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorModel"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ],
        "summary": "Get transaction for claiming rewards",
        "tags": [
          "Protocol Rewards"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://api.superform.xyz"
    }
  ]
}
```