Skip to main content
API docs by Redocly

FiledGr API (0.1.0)

Download OpenAPI specification:Download

attachments

Get Data Attachments

Authorizations:
api-keyapi-secret
query Parameters
page_size
integer (Page Size)
Default: 10
page
integer (Page)
Default: 1

Responses

Request samples 

curl -X GET "https://api.filedgr.com/attachments" \
    -H "x-api-key: YOUR_API_KEY" \
    -H "x-api-secret: YOUR_API_SECRET" \
    -H "accept: application/json"

Response samples

Content type
application/json
{
  • "total_records": 0,
  • "current_page": 0,
  • "total_pages": 0,
  • "content": [ ]
}

Add Data Attachment

Authorizations:
api-keyapi-secret
Request Body schema: application/json
required
name
required
string (Name)
Description (string) or Description (null) (Description)
stream_id
required
string <uuid> (Stream Id)
ledger
required
string (Ledgers)
Enum: "XRPL" "POLYGON_ZKEVM" "POLYGON_POS" "ETHEREUM"
Filename (string) or Filename (null) (Filename)
upload_as_zip
boolean (Upload As Zip)
Default: false

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "stream_id": "173fd1b7-72c4-44c4-9244-55a0a167a352",
  • "ledger": "XRPL",
  • "filename": "string",
  • "upload_as_zip": false
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "ledger": "XRPL",
  • "status": "FILEDGR_RECEIVED",
  • "presigned_url": "",
  • "stream_id": "173fd1b7-72c4-44c4-9244-55a0a167a352",
  • "filename": "string",
  • "tx_hash": "string",
  • "upload_as_zip": false,
  • "size": 0,
  • "stream": {
    },
  • "file_count": 0,
  • "files": [ ],
  • "progress": [
    ]
}

Get Data Attachment

Authorizations:
api-keyapi-secret
path Parameters
data_attachment_id
required
string <uuid> (Data Attachment Id)

Responses

Request samples 

curl -X GET "https://api.filedgr.com/attachments/123e4567-e89b-12d3-a456-426614174000" \
    -H "x-api-key: YOUR_API_KEY" \
    -H "x-api-secret: YOUR_API_SECRET" \
    -H "accept: application/json"

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "ledger": "XRPL",
  • "status": "FILEDGR_RECEIVED",
  • "presigned_url": "",
  • "stream_id": "173fd1b7-72c4-44c4-9244-55a0a167a352",
  • "filename": "string",
  • "tx_hash": "string",
  • "upload_as_zip": false,
  • "size": 0,
  • "stream": {
    },
  • "file_count": 0,
  • "files": [ ],
  • "progress": [
    ]
}

users

Get User

Authorizations:
api-keyapi-secret

Responses

Request samples 

curl -X GET "https://api.filedgr.com/users" \
    -H "x-api-key: YOUR_API_KEY" \
    -H "x-api-secret: YOUR_API_SECRET" \
    -H "accept: application/json"

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "first_name": "string",
  • "last_name": "string",
  • "username": "string",
  • "user_profile_picture": false,
  • "created_at": "2019-08-24T14:15:22Z",
  • "entities": [
    ],
  • "credentials": [
    ],
  • "image_upload_url": "string",
  • "image_download_url": "string"
}

Add Favorite

Authorizations:
api-keyapi-secret
Request Body schema: application/json
required
type
required
string (FavoriteType)
Enum: "NFT" "TOKEN"
ref
required
string (Ref)

Responses

Request samples

Content type
application/json
{
  • "type": "NFT",
  • "ref": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "type": "NFT",
  • "ref": "string"
}

Get Favorites

Authorizations:
api-keyapi-secret
query Parameters
page_size
integer (Page Size)
Default: 10
page
integer (Page)
Default: 1

Responses

Request samples 

curl -X GET "https://api.filedgr.com/users/123e4567-e89b-12d3-a456-426614174000/favorites?page=1&page_size=10" \
    -H "x-api-key: YOUR_API_KEY" \
    -H "x-api-secret: YOUR_API_SECRET" \
    -H "accept: application/json"

Response samples

Content type
application/json
{
  • "total_records": 0,
  • "current_page": 0,
  • "total_pages": 0,
  • "content": [ ]
}

Get Favorite

Authorizations:
api-keyapi-secret
path Parameters
favorite_id
required
string <uuid> (Favorite Id)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "type": "NFT",
  • "ref": "string"
}

Delete Favorite

Authorizations:
api-keyapi-secret
path Parameters
favorite_id
required
string <uuid> (Favorite Id)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "type": "NFT",
  • "ref": "string"
}

templates

Get Templates

Authorizations:
api-keyapi-secret
query Parameters
page_size
integer (Page Size)
Default: 10
page
integer (Page)
Default: 1
public
boolean (Public)
Default: false
search_term
string (Search Term)
Default: ""
sort_by
string (Sort By)
Default: ""
sort_type
string (Sort Type)
Default: ""

Responses

Request samples 

curl -X GET "https://api.filedgr.com/templates?page=1&page_size=10&public=false&search_term=&sort_by=&sort_type=" \
    -H "x-api-key: YOUR_API_KEY" \
    -H "x-api-secret: YOUR_API_SECRET" \
    -H "accept: application/json"

Response samples

Content type
application/json
{
  • "total_records": 0,
  • "current_page": 0,
  • "total_pages": 0,
  • "content": [ ]
}

Add Template

Authorizations:
api-keyapi-secret
Request Body schema: application/json
required
name
required
string (Name)
Description (string) or Description (null) (Description)
public
boolean (Public)
Default: false
hint
required
string (Hint)
required_streams
required
Array of strings (Required Streams)
Author (string) or Author (null) (Author)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "public": false,
  • "hint": "string",
  • "required_streams": [
    ],
  • "author": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "author": "string",
  • "status": "UPLOAD_PENDING",
  • "template_dir": "string",
  • "default_image": "string",
  • "default_image_cid": "string",
  • "image_upload_url": "string",
  • "upload_url": "string",
  • "size": 0,
  • "public": true,
  • "hint": "string",
  • "required_streams": [
    ]
}

Get Template

Authorizations:
api-keyapi-secret
path Parameters
template_id
required
string <uuid> (Template Id)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "author": "string",
  • "status": "UPLOAD_PENDING",
  • "template_dir": "string",
  • "default_image": "string",
  • "default_image_cid": "string",
  • "image_upload_url": "string",
  • "upload_url": "string",
  • "size": 0,
  • "public": true,
  • "hint": "string",
  • "required_streams": [
    ]
}

vaults

Get Vaults

Authorizations:
api-keyapi-secret
query Parameters
page_size
integer (Page Size)
Default: 10
page
integer (Page)
Default: 1

Responses

Request samples 

curl -X GET "https://api.filedgr.com/vaults?page=1&page_size=10" \
    -H "x-api-key: YOUR_API_KEY" \
    -H "x-api-secret: YOUR_API_SECRET" \
    -H "accept: application/json"

Response samples

Content type
application/json
{
  • "total_records": 0,
  • "current_page": 0,
  • "total_pages": 0,
  • "content": [ ]
}

Add Vault

Authorizations:
api-keyapi-secret
Request Body schema: application/json
required
template_id
required
string <uuid> (Template Id)
name
required
string (Name)
Description (string) or Description (null) (Description)
Ledgers (string) or null
Default: "XRPL"
Json Payload (string) or Json Payload (null) (Json Payload)
Public (boolean) or Public (null) (Public)
Default: true

Responses

Request samples

Content type
application/json
{
  • "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
  • "name": "string",
  • "description": "string",
  • "ledger": "XRPL",
  • "json_payload": "string",
  • "public": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
  • "status": "FILEDGR_RECEIVED",
  • "ledger": "XRPL",
  • "tx_hash": "string",
  • "nft_network_issuer": "string",
  • "nft_network_owner": "string",
  • "nft_network_id": "string",
  • "cid": "string",
  • "image_cid": "string",
  • "default_image_cid": "string",
  • "metadata_cid": "string",
  • "streams": [
    ],
  • "public": true,
  • "json_payload": "string",
  • "image_upload_url": "string",
  • "custom_image": false,
  • "progress": [
    ]
}

Get Vault

Authorizations:
api-keyapi-secret
path Parameters
vault_id
required
string <uuid> (Vault Id)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
  • "status": "FILEDGR_RECEIVED",
  • "ledger": "XRPL",
  • "tx_hash": "string",
  • "nft_network_issuer": "string",
  • "nft_network_owner": "string",
  • "nft_network_id": "string",
  • "cid": "string",
  • "image_cid": "string",
  • "default_image_cid": "string",
  • "metadata_cid": "string",
  • "streams": [
    ],
  • "public": true,
  • "json_payload": "string",
  • "image_upload_url": "string",
  • "custom_image": false,
  • "progress": [
    ]
}

streams

Get Streams

Authorizations:
api-keyapi-secret
query Parameters
page_size
integer (Page Size)
Default: 10
page
integer (Page)
Default: 1

Responses

Request samples 

curl -X GET "https://api.filedgr.com/streams?page=1&page_size=10" \
    -H "x-api-key: YOUR_API_KEY" \
    -H "x-api-secret: YOUR_API_SECRET" \
    -H "accept: application/json"

Response samples

Content type
application/json
{
  • "total_records": 0,
  • "current_page": 0,
  • "total_pages": 0,
  • "content": [ ]
}

Add Stream

Authorizations:
api-keyapi-secret
Request Body schema: application/json
required
asset_code
required
string (Asset Code)
required
Description (string) or Description (null) (Description)

Responses

Request samples

Content type
application/json
{
  • "asset_code": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "asset_code": "string",
  • "description": "string",
  • "ledger": "XRPL",
  • "tx_hash": "string",
  • "status": "FILEDGR_RECEIVED",
  • "issuer": "string",
  • "distribution_wallet": "string",
  • "mapping": "string",
  • "metadata_cid": "string",
  • "progress": [
    ]
}

Get Stream

Authorizations:
api-keyapi-secret
path Parameters
stream_id
required
string <uuid> (Stream Id)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "asset_code": "string",
  • "description": "string",
  • "ledger": "XRPL",
  • "tx_hash": "string",
  • "status": "FILEDGR_RECEIVED",
  • "issuer": "string",
  • "distribution_wallet": "string",
  • "mapping": "string",
  • "metadata_cid": "string",
  • "progress": [
    ]
}

Get Stream Attachments

Authorizations:
api-keyapi-secret
path Parameters
stream_code
required
string (Stream Code)
query Parameters
page_size
integer (Page Size)
Default: 10
page
integer (Page)
Default: 1

Responses

Request samples 

curl -X GET "https://api.filedgr.com/streams/MYSTREAM/attachments?page=1&page_size=10" \
    -H "x-api-key: YOUR_API_KEY" \
    -H "x-api-secret: YOUR_API_SECRET" \
    -H "accept: application/json"

Response samples

Content type
application/json
{
  • "total_records": 0,
  • "current_page": 0,
  • "total_pages": 0,
  • "content": [ ]
}