Fetch all Claims

`GET` request to `/claims` to retrieve all Claims in a paginated list.

GET to /claims

Retrieves a list of Claims. Returns a paginated list of Claims.

GET https://api.intuition.systems?<Query_Parameters>

Fetch

   await fetch(`${apiUrl}/claims?${queryParams}`, {
      method: 'GET',
      "headers": {
        "Content-Type": "application/json",
        "x-api-key": <API_KEY>
      },
    })

Curl

curl "https://api.intuition.systems/claims?<Query_Parameters>" \
     -H "Content-Type: application/json" \
     -H "x-api-key: <API_Key>" \
     -X GET

Replace the <API_Key> with your valid API Key.

Replace the <Query_Parameters> with query parameters you want to include.

Security

This request requires a valid API Key to be included with each request.

Headers

• Content-Type: application/json

• x-api-key: <API_Key>

Query Parameters

Parameter	Description
page	Current page in sequence
limit	number Max number of items returned on single page Example: 1
sortBy	string Field to sort by. Default is created_at Example: "creator"
direction	string - "desc" or "asc" Direction to sort. Default is desc Example: "desc"

Response

This includes the Paginated Response

{
    "page": 1, // The current page in pagination sequence
    "limit": 100, // The max number of items returned on a single page
    "total": 50, // Total number of items 
    "data": [{}] // Array of response items
}

You'll receive back a data array that is a paginated list of all available Claims.

{
  "page": 1,
  "limit": 100,
  "total": 79,
  "data": [{}],
  ]
}

Here is an example Zod schema and TypeScript interface you can use for the Claim:

Zod Schema

export const ClaimSchema = z.object({
  claim_id: z.string(),
  vault_id: z.string(),
  counter_vault_id: z.string(),
  created_at: z.string().transform((date) => {
    const d = new Date(Number.parseInt(date))
    return d.toISOString()
  }), // unix timestamp
  updated_at: z.string(), // unix timestamp (last claim position update)
  creator: EmbedUserUserAggregatesSchema.optional(),
  subject: IdentitySchema,
  predicate: IdentitySchema,
  object: IdentitySchema,
  status: z.enum(['pending', 'complete']),
  for_num_positions: z.number(),
  for_assets_sum: z.string(), // bigint
  for_conviction_sum: z.string(), // bigint
  for_conviction_price: z.string(), // bigint
  against_num_positions: z.number(),
  against_assets_sum: z.string(), // bigint
  against_conviction_sum: z.string(), // bigint
  against_conviction_price: z.string(), // bigint
})

Interface

 // if using Zod, you can directly infer:
 
export type Claim = z.infer<typeof ClaimSchema>

// used in another interface:

interface OffChainClaimFetcherData {
  success: 'success' | 'error'
  claim: Claim
}

// if not using Zod, here's an example of the Claim type:

type Claim = {
        claim_id: string;
        vault_id: string;
        created_at: string;
        updated_at: string;
    };
}

Response Codes

Code	Description
200	Paginated list of Claims
400	Bad Request. Example: Unsupported value for sortBy query parameter.