Pulsy

https://docs.pulsy.app
Admin
Pulsy is a complete suite for tracking Web3 data that provides real-time DeFi feeds, cross-chain...
Tokens:6,273
Snippets:31
Trust Score:6
Update:10 months ago
Show doc for...
Tokens:
Raw
### Get Supported Tokens

Source: https://docs.pulsy.app/xflow/api-reference/endpoints/get_tokens

Retrieves a list of all tokens supported by the Pulsy App for the specified website.

```APIDOC
## GET /websites/pulsy_app/tokens

### Description
Retrieves a list of all tokens supported by the Pulsy App for the specified website.

### Method
GET

### Endpoint
/websites/pulsy_app/tokens

### Parameters

#### Query Parameters
None

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **tokens** (array) - A list of supported token objects.
  - **id** (string) - The unique identifier for the token.
  - **symbol** (string) - The symbol of the token (e.g., 'ETH', 'BTC').
  - **name** (string) - The full name of the token (e.g., 'Ethereum', 'Bitcoin').
  - **decimals** (integer) - The number of decimal places the token uses.

#### Response Example
```json
{
  "tokens": [
    {
      "id": "0x123...",
      "symbol": "ETH",
      "name": "Ethereum",
      "decimals": 18
    },
    {
      "id": "0xabc...",
      "symbol": "BTC",
      "name": "Bitcoin",
      "decimals": 8
    }
  ]
}
```
```

--------------------------------

### GET /v1/external/swaps

Source: https://docs.pulsy.app/xflow/api-reference/endpoints/get_swaps

Retrieves cross-chain swaps detected within the requested timeframe. The timeframe between 'from' and 'to' must not exceed 30 minutes.

```APIDOC
## GET /v1/external/swaps

### Description
Retrieves cross-chain swaps detected within the requested timeframe. The timeframe between `from` and `to` must not exceed 30 minutes.

### Method
GET

### Endpoint
https://api.pulsy.app/v1/external/swaps

### Parameters
#### Query Parameters
- **From** (string) - Required - The start of the timeframe (date-time format).
- **To** (string) - Required - The end of the timeframe (date-time format).
- **Filter** (string) - Optional - Filters the swaps by status. Allowed values: `Withdrawn`, `Deposited`, `Completed`. Defaults to `Withdrawn`.

### Response
#### Success Response (200)
- **TransactionSwapExported** (object) - An array of transaction swap objects.
  - **id** (string) - Swap unique identifier.
  - **timestamp** (string) - Date and time when a swap was detected by XFlow (deprecated).
  - **depositedAt** (string) - Date and time when a swap's deposit transaction was made on the inbound chain.
  - **withdrawnAt** (string) - Date and time when a swap's withdrawal transaction was made on the outbound chain.
  - **detectedAt** (string) - Date and time when a swap was detected by XFlow.
  - **completedAt** (string) - Date and time when a swap was completed by XFlow.
  - **bridge** (string) - Name of the bridge that processed the swap.
  - **bridgeKey** (string) - Key of the bridge that processed the swap.
  - **sourceChain** (string) - Chain on which the inbound transaction was submitted.
  - **destinationChain** (string) - Chain on which the outbound transaction was submitted.
  - **sourceAccount** (string) - Account from which the swap was initiated.

#### Error Response (400)
- **DefaultValidationProblemDetails** (object) - Details about a validation problem.

#### Error Response (403)
- **DefaultProblemDetails** (object) - Details about a forbidden request.

#### Error Response (404)
- **ProblemDetails** (object) - Details about a not found resource.

#### Error Response (default)
- **UnexpectedProblemDetails** (object) - Details about an unexpected error.

### Request Example
```json
{
  "example": "GET /v1/external/swaps?From=2023-10-27T10:00:00Z&To=2023-10-27T10:30:00Z&Filter=Completed"
}
```

### Response Example (200 OK)
```json
{
  "example": [
    {
      "id": "swap-123",
      "timestamp": "2023-10-27T10:15:00Z",
      "depositedAt": "2023-10-27T10:15:05Z",
      "withdrawnAt": "2023-10-27T10:20:10Z",
      "detectedAt": "2023-10-27T10:15:01Z",
      "completedAt": "2023-10-27T10:25:15Z",
      "bridge": "Uniswap",
      "bridgeKey": "uni-v3",
      "sourceChain": "Ethereum",
      "destinationChain": "Polygon",
      "sourceAccount": "0x123...abc"
    }
  ]
}
```
```

--------------------------------

### Get Cross-Chain Swaps

Source: https://docs.pulsy.app/xflow/api-reference/endpoints/get_swaps

Retrieves cross-chain swap data within a specified time range. The maximum allowed timeframe between 'from' and 'to' is 30 minutes.

```APIDOC
## GET /websites/pulsy_app/swaps

### Description
Retrieves cross-chain swap data within a specified time range. The maximum allowed timeframe between 'from' and 'to' is 30 minutes.

### Method
GET

### Endpoint
/websites/pulsy_app/swaps

### Parameters
#### Query Parameters
- **from** (integer) - Required - The start of the time range (Unix timestamp).
- **to** (integer) - Required - The end of the time range (Unix timestamp).

### Request Example
```
GET /websites/pulsy_app/swaps?from=1678886400&to=1678888200
```

### Response
#### Success Response (200)
- **swaps** (array) - An array of swap objects.
  - **id** (string) - The unique identifier for the swap.
  - **from_chain** (string) - The source chain of the swap.
  - **to_chain** (string) - The destination chain of the swap.
  - **amount** (string) - The amount swapped.
  - **timestamp** (integer) - The Unix timestamp of the swap.

#### Response Example
```json
{
  "swaps": [
    {
      "id": "swap123",
      "from_chain": "ethereum",
      "to_chain": "polygon",
      "amount": "1.0",
      "timestamp": 1678887300
    }
  ]
}
```
```

--------------------------------

### GET /v1/external/chains

Source: https://docs.pulsy.app/xflow/api-reference/endpoints/get_chains

Retrieves all blockchains tracked by XFlow. This endpoint provides a list of supported blockchains with their respective details.

```APIDOC
## GET /v1/external/chains

### Description
Retrieves all blockchains tracked by XFlow. This endpoint provides a list of supported blockchains with their respective details.

### Method
GET

### Endpoint
/v1/external/chains

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **blockchainId** (string) - Unique identifier of the blockchain.
- **name** (string) - Human-readable blockchain name.
- **explorerUrl** (string) - URL of the chain explorer.

#### Response Example
```json
[
  {
    "blockchainId": "bitcoin",
    "name": "Bitcoin",
    "explorerUrl": "https://www.blockchain.com/"
  },
  {
    "blockchainId": "ethereum",
    "name": "Ethereum",
    "explorerUrl": "https://etherscan.io/"
  }
]
```

#### Error Responses
- **400 Bad Request**: Returned when the request is malformed or invalid.
- **403 Forbidden**: Returned when the authenticated user does not have permission to access the resource.
- **404 Not Found**: Returned when the requested resource does not exist.
- **Default Error**: Returned for any unexpected errors during the request.
```

--------------------------------

### GET /v1/external/chains/{blockchainId}/tokens

Source: https://docs.pulsy.app/xflow/api-reference/endpoints/get_tokens

Retrieves a paginated list of tokens that XFlow tracks for a specified blockchain. This endpoint is useful for discovering which tokens are supported on a given network.

```APIDOC
## GET /v1/external/chains/{blockchainId}/tokens

### Description
Retrieves the tokens XFlow tracks for the specified blockchain.

### Method
GET

### Endpoint
`/v1/external/chains/{blockchainId}/tokens`

### Parameters
#### Path Parameters
- **blockchainId** (string) - Required - Identifier of the blockchain.

#### Query Parameters
- **Take** (integer) - Optional - Maximum number of items to return (0-1000).
- **Offset** (integer) - Optional - Number of items to skip (0-100000).

### Request Example
```json
{
  "example": "Not applicable for GET request"
}
```

### Response
#### Success Response (200)
- **items** (array) - An array of supported tokens, or null if none.
- **totalCount** (integer) - The total number of tokens available for the specified blockchain.

#### Response Example
```json
{
  "items": [
    {
      "symbol": "ETH",
      "address": "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
      "decimals": 18,
      "logoUrl": "https://api.pulsy.app/logos/eth.png"
    }
  ],
  "totalCount": 1500
}
```

#### Error Responses
- **400 Bad Request**: Indicates invalid input parameters.
- **403 Forbidden**: Indicates that the authenticated user does not have permission to access this resource.
- **404 Not Found**: Indicates that the specified blockchain was not found.
- **default Error**: Catches any other unexpected server errors.
```

--------------------------------

### GET /v1/external/bridges

Source: https://docs.pulsy.app/xflow/api-reference/endpoints/get_bridges

Retrieves a list of all bridges that XFlow tracks on supported chains, sorted by their trading volume. This endpoint is useful for obtaining an overview of available bridges and their performance metrics.

```APIDOC
## GET /v1/external/bridges

### Description
Returns all bridges whose on-chain contracts XFlow tracks across supported chains, sorted by volume.

### Method
GET

### Endpoint
/v1/external/bridges

### Parameters

#### Query Parameters
(No query parameters defined in the OpenAPI spec)

#### Request Body
(This endpoint does not accept a request body)

### Request Example
(No request body example provided)

### Response
#### Success Response (200)
- **earliestSwapTimestamp** (string) - Timestamp of the earliest swap tracked for the bridge.
- **latestSwapTimestamp** (string) - Timestamp of the latest swap tracked for the bridge.
- **allTimeSwapsCount** (integer) - Total number of swaps tracked for the bridge.
- **supportedChains** (array of strings) - Chains whose bridge contracts are tracked by XFlow.
- **url** (string) - Official website or documentation URL of the bridge.
- **icon** (string) - Bridge icon URL.
- **key** (string) - Unique bridge key.
- **name** (string) - Human-readable bridge name.
- **allTimeSwapsVolume** (number) - All-time swap volume tracked for the bridge (in USD).
- **status** (string, enum: Operational, Warning, Malfunction) - Current bridge status in XFlow.

#### Response Example
```json
[
  {
    "earliestSwapTimestamp": "2023-01-01T00:00:00Z",
    "latestSwapTimestamp": "2024-01-01T12:00:00Z",
    "allTimeSwapsCount": 100000,
    "supportedChains": ["Ethereum", "Polygon"],
    "url": "https://example-bridge.com",
    "icon": "https://example-bridge.com/icon.png",
    "key": "example_bridge",
    "name": "Example Bridge",
    "allTimeSwapsVolume": 500000000.50,
    "status": "Operational"
  }
]
```

#### Error Responses
- **400 Bad Request**: Details provided in `DefaultValidationProblemDetails` schema.
- **403 Forbidden**: Details provided in `DefaultProblemDetails` schema.
- **404 Not Found**: Details provided in `ProblemDetails` schema.
- **default Error**: Details provided in `UnexpectedProblemDetails` schema.
```

--------------------------------

### Fetch LLMS Data

Source: https://docs.pulsy.app/xflow/api-reference/endpoints/get_chains

Retrieves navigation and other pages from the llms.txt file.

```APIDOC
## GET /websites/pulsy_app/llms.txt

### Description
Fetches the llms.txt file which contains navigation and other page data for the Pulsy App.

### Method
GET

### Endpoint
/websites/pulsy_app/llms.txt

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **content** (string) - The content of the llms.txt file.

#### Response Example
```json
{
  "content": "..."
}
```
```

--------------------------------

### Authentication Schemas

Source: https://docs.pulsy.app/xflow/api-reference/endpoints/get_swaps

Details on the security schemes supported by the API, including Basic and Bearer token authentication.

```APIDOC
## Authentication Schemas

### Basic Authentication

**Description**: Basic auth required for external APIs. 
**Example**: "Authorization: Basic {base64EncodedPasswordString}"

### Bearer Token Authentication

**Description**: JWT Authorization header using the Bearer scheme.
**Example**: "Authorization: Bearer {token}"
```

--------------------------------

### Security Schemes

Source: https://docs.pulsy.app/xflow/api-reference/endpoints/get_chains

Details the security schemes available for API authentication.

```APIDOC
## Security Schemes

### Description
Details the authentication methods supported by the API.

### Basic Authentication
- **Type**: http
- **Scheme**: basic
- **Description**: Basic auth required for external APIs. Example: "Authorization: Basic {base64EncodedPasswordString}"

### Bearer Token Authentication
- **Type**: apiKey
- **Name**: Authorization
- **In**: header
- **Description**: JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"
```

--------------------------------

### BlockWithTraces Data Structure (JSON)

Source: https://docs.pulsy.app/atria/getting-started/01-introduction

Represents a block with debug traces. This structure contains metadata and a list of traces, including transaction hash and execution results like 'from', 'to', and 'value'. It is useful for detailed debugging and analysis of complex transaction flows.

```json
{
  "metadata": {
    "networkId": "...",
    "blockNumber": "...",
    "isReorg": false
  },
  "traces": [
    {
      "txHash": "...",
      "result": {
        "from": "...",
        "to": "...",
        "value": "..."
      }
    }
  ]
}
```

--------------------------------

### BlockWithLogs Data Structure (JSON)

Source: https://docs.pulsy.app/atria/getting-started/01-introduction

Represents a block containing event logs. It includes metadata and a list of logs, where each log has an address, data, and topics. This structure is crucial for tracking smart contract interactions and emitted events.

```json
{
  "metadata": {
    "networkId": "...",
    "blockNumber": "...",
    "isReorg": false
  },
  "logs": [
    {
      "address": "...",
      "data": "...",
      "topics": ["..."]
    }
  ]
}
```

--------------------------------

### Data Models

Source: https://docs.pulsy.app/xflow/api-reference/endpoints/get_swaps

Defines the structure of various data models used within the API, including ProblemDetails, TagDto, and UnexpectedProblemDetails.

```APIDOC
## Data Models

### ProblemDetails

**Description**: Represents a standardized error object.

**Properties**:
- **type** (string, nullable) - The type of the problem.
- **title** (string, nullable) - A short, human-readable summary of the problem.
- **status** (integer, format: int32, nullable) - The HTTP status code.
- **detail** (string, nullable) - A human-readable explanation specific to this occurrence of the problem.
- **instance** (string, nullable) - A URI reference that identifies the specific occurrence of the problem.

### UnexpectedProblemDetails

**Description**: Represents an unexpected error object.

**Properties**:
- **timestamp** (string, format: date-time) - The date and time of the error.
- **traceId** (string, nullable) - The trace identifier for the error.
- **type** (string, nullable) - The type of the problem.
- **title** (string, nullable) - A short, human-readable summary of the problem.
- **status** (integer, format: int32, nullable) - The HTTP status code.
- **detail** (string, nullable) - A human-readable explanation specific to this occurrence of the problem.
- **instance** (string, nullable) - A URI reference that identifies the specific occurrence of the problem.

### TagDto

**Description**: Represents a tag with a type and value.

**Properties**:
- **type** (string, nullable) - The type of the tag.
- **value** (string, nullable) - The value of the tag.
```

--------------------------------

### Transaction Details

Source: https://docs.pulsy.app/xflow/api-reference/endpoints/get_swaps

Retrieves detailed information about a specific transaction, including source and destination accounts, tokens, amounts, and USD equivalents. It also provides status on USD mismatch and associated tags.

```APIDOC
## GET /websites/pulsy_app/transactions/{id}

### Description
Retrieves detailed information about a specific transaction.

### Method
GET

### Endpoint
/websites/pulsy_app/transactions/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the transaction.

### Response
#### Success Response (200)
- **sourceAccount** (string) - Account that submitted the inbound transaction.
- **destinationAccount** (string) - Account that received the outbound transaction.
- **sourceInteractedWith** (string) - InteractedWith address in the inbound transaction (only for EVM chains).
- **protocolKey** (string) - Key of the protocol that processed the swap.
- **sourceProtocolAddress** (string) - Address of the protocol that emitted the swap in the inbound transaction.
- **destinationProtocolAddress** (string) - Address of the protocol that finished the swap in the outbound transaction.
- **intermediateSwapId** (string) - Intermediate swap identifier (deprecated).
- **sourceOtherProtocolAddresses** (array of strings) - Other protocol addresses that emitted events tracked by XFlow to identify the swap in the inbound transaction.
- **destinationOtherProtocolAddresses** (array of strings) - Other protocol addresses that emitted events tracked by XFlow to identify the swap in the outbound transaction.
- **sourceTransaction** (string) - Inbound transaction hash.
- **destinationTransaction** (string) - Outbound transaction hash.
- **sourceToken** (string) - Inbound token on the source chain.
- **destinationToken** (string) - Outbound token on the destination chain.
- **sourceTokenContract** (string) - Inbound token contract address.
- **destinationTokenContract** (string) - Outbound token contract address.
- **depositAmount** (number) - Deposited amount in source tokens.
- **withdrawnAmount** (number) - Withdrawn amount in destination tokens.
- **depositUsdAmount** (number) - Deposited amount in USD equivalent.
- **withdrawnUsdAmount** (number) - Withdrawn amount in USD equivalent.
- **usdMismatchStatus** (string) - Indicates whether deposited and withdrawn USD amounts are within an acceptable range (`Unprocessed`, `NotFound`, `MismatchDetected`, `OK`).
- **tags** (array of TagDto) - Optional field returning extra information for certain swaps.

#### Response Example
```json
{
  "sourceAccount": "0x123...",
  "destinationAccount": "0x456...",
  "sourceInteractedWith": "0x789...",
  "protocolKey": "uniswap_v2",
  "sourceProtocolAddress": "0xabc...",
  "destinationProtocolAddress": "0xdef...",
  "intermediateSwapId": null,
  "sourceOtherProtocolAddresses": [],
  "destinationOtherProtocolAddresses": [],
  "sourceTransaction": "0xsrc_tx_hash",
  "destinationTransaction": "0xdest_tx_hash",
  "sourceToken": "ETH",
  "destinationToken": "USDC",
  "sourceTokenContract": "0xsrc_token_addr",
  "destinationTokenContract": "0xdst_token_addr",
  "depositAmount": 1.5,
  "withdrawnAmount": 3000.0,
  "depositUsdAmount": 4500.0,
  "withdrawnUsdAmount": 2990.0,
  "usdMismatchStatus": "MismatchDetected",
  "tags": [
    {"key": "thor-affiliate", "value": "true"},
    {"key": "nft", "value": "deposit"}
  ]
}
```

#### Error Response (400 Bad Request)
- **errorCode** (string) - Error code.
- **errors** (object) - Object containing validation errors.
- **type** (string) - Type of the error.
- **title** (string) - Title of the error.
- **status** (integer) - HTTP status code.
- **detail** (string) - Detailed error message.
- **instance** (string) - Instance of the error.

#### Error Response Example
```json
{
  "errors": {
    "transactionId": [
      "Transaction ID is required."
    ]
  },
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "detail": "Validation failed.",
  "instance": "/websites/pulsy_app/transactions/invalid_id"
}
```
```

--------------------------------

### BlockWithTransactions Data Structure (JSON)

Source: https://docs.pulsy.app/atria/getting-started/01-introduction

Represents a block with its associated transactions. Includes metadata like network ID and block number, along with transaction details such as sender, receiver, and value. This structure is used for monitoring transaction-level events on the blockchain.

```json
{
  "metadata": {
    "networkId": "...",
    "blockNumber": "...",
    "isReorg": false
  },
  "block": {
    "number": "...",
    "hash": "...",
    "timestamp": "...",
    "transactions": [
      {
        "hash": "...",
        "from": "...",
        "to": "...",
        "value": "..."
      }
    ]
  }
}
```
Tokens:
Raw