Swagger\Client\DealsApi

All URIs are relative to //api.estuary.tech/

Method	HTTP request	Description
dealEstimatePost	POST /deal/estimate	Estimate the cost of a deal
dealInfoDealidGet	GET /deal/info/{dealid}	Get Deal Info
dealProposalPropcidGet	GET /deal/proposal/{propcid}	Get Proposal
dealQueryMinerGet	GET /deal/query/{miner}	Query Ask
dealStatusByProposalPropcidGet	GET /deal/status-by-proposal/{propcid}	Get Deal Status by PropCid
dealStatusMinerPropcidGet	GET /deal/status/{miner}/{propcid}	Deal Status
dealTransferInProgressGet	GET /deal/transfer/in-progress	Transfer In Progress
dealTransferStatusPost	POST /deal/transfer/status	Transfer Status
dealsFailuresGet	GET /deals/failures	Get storage failures for user
dealsMakeMinerPost	POST /deals/make/{miner}	Make Deal
dealsStatusDealGet	GET /deals/status/{deal}	Get Deal Status
publicDealsFailuresGet	GET /public/deals/failures	Get storage failures
publicMinersStorageQueryMinerGet	GET /public/miners/storage/query/{miner}	Query Ask

dealEstimatePost

string dealEstimatePost($body)

Estimate the cost of a deal

This endpoint estimates the cost of a deal

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\DealsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \Swagger\Client\Model\ApiEstimateDealBody(); // \Swagger\Client\Model\ApiEstimateDealBody | The size of the deal in bytes, the replication factor, and the duration of the deal in blocks

try {
    $result = $apiInstance->dealEstimatePost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DealsApi->dealEstimatePost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Swagger\Client\Model\ApiEstimateDealBody	The size of the deal in bytes, the replication factor, and the duration of the deal in blocks

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: /
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dealInfoDealidGet

string dealInfoDealidGet($dealid)

Get Deal Info

This endpoint returns the deal info for a deal

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\DealsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$dealid = 56; // int | Deal ID

try {
    $result = $apiInstance->dealInfoDealidGet($dealid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DealsApi->dealInfoDealidGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
dealid	int	Deal ID

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dealProposalPropcidGet

string dealProposalPropcidGet($propcid)

Get Proposal

This endpoint returns the proposal for a deal

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\DealsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$propcid = "propcid_example"; // string | Proposal CID

try {
    $result = $apiInstance->dealProposalPropcidGet($propcid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DealsApi->dealProposalPropcidGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
propcid	string	Proposal CID

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dealQueryMinerGet

string dealQueryMinerGet($miner)

Query Ask

This endpoint returns the ask for a given CID

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\DealsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$miner = "miner_example"; // string | CID

try {
    $result = $apiInstance->dealQueryMinerGet($miner);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DealsApi->dealQueryMinerGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
miner	string	CID

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dealStatusByProposalPropcidGet

string dealStatusByProposalPropcidGet($propcid)

Get Deal Status by PropCid

Get Deal Status by PropCid

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\DealsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$propcid = "propcid_example"; // string | PropCid

try {
    $result = $apiInstance->dealStatusByProposalPropcidGet($propcid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DealsApi->dealStatusByProposalPropcidGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
propcid	string	PropCid

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dealStatusMinerPropcidGet

string dealStatusMinerPropcidGet($miner, $propcid)

Deal Status

This endpoint returns the status of a deal

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\DealsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$miner = "miner_example"; // string | Miner
$propcid = "propcid_example"; // string | Proposal CID

try {
    $result = $apiInstance->dealStatusMinerPropcidGet($miner, $propcid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DealsApi->dealStatusMinerPropcidGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
miner	string	Miner
propcid	string	Proposal CID

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dealTransferInProgressGet

string dealTransferInProgressGet()

Transfer In Progress

This endpoint returns the in-progress transfers

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\DealsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->dealTransferInProgressGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DealsApi->dealTransferInProgressGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dealTransferStatusPost

string dealTransferStatusPost($body)

Transfer Status

This endpoint returns the status of a transfer

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\DealsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \Swagger\Client\Model\ApiChannelIDParam(); // \Swagger\Client\Model\ApiChannelIDParam | Channel ID

try {
    $result = $apiInstance->dealTransferStatusPost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DealsApi->dealTransferStatusPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Swagger\Client\Model\ApiChannelIDParam	Channel ID

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: /
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dealsFailuresGet

string dealsFailuresGet()

Get storage failures for user

This endpoint returns a list of storage failures for user

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\DealsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->dealsFailuresGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DealsApi->dealsFailuresGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dealsMakeMinerPost

string dealsMakeMinerPost($body, $miner)

Make Deal

This endpoint makes a deal for a given content and miner

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\DealsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = "body_example"; // string | Deal Request
$miner = "miner_example"; // string | Miner

try {
    $result = $apiInstance->dealsMakeMinerPost($body, $miner);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DealsApi->dealsMakeMinerPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	string	Deal Request
miner	string	Miner

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: /
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dealsStatusDealGet

string dealsStatusDealGet($deal)

Get Deal Status

This endpoint returns the status of a deal

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\DealsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$deal = 56; // int | Deal ID

try {
    $result = $apiInstance->dealsStatusDealGet($deal);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DealsApi->dealsStatusDealGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
deal	int	Deal ID

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

publicDealsFailuresGet

string publicDealsFailuresGet()

Get storage failures

This endpoint returns a list of storage failures

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\DealsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->publicDealsFailuresGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DealsApi->publicDealsFailuresGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

publicMinersStorageQueryMinerGet

string publicMinersStorageQueryMinerGet($miner)

Query Ask

This endpoint returns the ask for a given CID

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\DealsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$miner = "miner_example"; // string | CID

try {
    $result = $apiInstance->publicMinersStorageQueryMinerGet($miner);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DealsApi->publicMinersStorageQueryMinerGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
miner	string	CID

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]