Akash Network Providers API
The Providers API from Akash Network — 10 operation(s) for providers.
OpenAPI Specification
swagger: '2.0'
info:
title: AKASH - gRPC Gateway docs Addresses Providers API
description: A REST interface for state queries
version: 1.0.0
tags:
- name: Providers
paths:
/v1/providers:
get:
summary: Get a list of providers.
tags:
- Providers
security: []
parameters:
- schema:
type: string
enum:
- all
- trial
default: all
required: false
name: scope
in: query
- schema:
type: string
required: false
name: addresses
in: query
responses:
'200':
description: Returns a list of providers
content:
application/json:
schema:
type: array
items:
type: object
properties:
owner:
type: string
name:
type: string
nullable: true
hostUri:
type: string
createdHeight:
type: number
email:
type: string
nullable: true
website:
type: string
nullable: true
lastCheckDate:
type: string
nullable: true
deploymentCount:
type: number
nullable: true
leaseCount:
type: number
nullable: true
cosmosSdkVersion:
type: string
akashVersion:
type: string
ipRegion:
type: string
nullable: true
ipRegionCode:
type: string
nullable: true
ipCountry:
type: string
nullable: true
ipCountryCode:
type: string
nullable: true
ipLat:
type: string
nullable: true
ipLon:
type: string
nullable: true
uptime1d:
type: number
nullable: true
uptime7d:
type: number
nullable: true
uptime30d:
type: number
nullable: true
isValidVersion:
type: boolean
isOnline:
type: boolean
lastOnlineDate:
type: string
nullable: true
isAudited:
type: boolean
gpuModels:
type: array
items:
type: object
properties:
vendor:
type: string
model:
type: string
ram:
type: string
interface:
type: string
required:
- vendor
- model
- ram
- interface
attributes:
type: array
items:
type: object
properties:
key:
type: string
value:
type: string
auditedBy:
type: array
items:
type: string
required:
- key
- value
- auditedBy
host:
type: string
nullable: true
organization:
type: string
nullable: true
statusPage:
type: string
nullable: true
locationRegion:
type: string
nullable: true
country:
type: string
nullable: true
city:
type: string
nullable: true
timezone:
type: string
nullable: true
locationType:
type: string
nullable: true
hostingProvider:
type: string
nullable: true
hardwareCpu:
type: string
nullable: true
hardwareCpuArch:
type: string
nullable: true
hardwareGpuVendor:
type: string
nullable: true
hardwareGpuModels:
type: array
nullable: true
items:
type: string
hardwareDisk:
type: array
nullable: true
items:
type: string
featPersistentStorage:
type: boolean
featPersistentStorageType:
type: array
nullable: true
items:
type: string
hardwareMemory:
type: string
nullable: true
networkProvider:
type: string
nullable: true
networkSpeedDown:
type: number
networkSpeedUp:
type: number
tier:
type: string
nullable: true
featEndpointCustomDomain:
type: boolean
workloadSupportChia:
type: boolean
workloadSupportChiaCapabilities:
type: array
nullable: true
items:
type: string
featEndpointIp:
type: boolean
required:
- owner
- name
- hostUri
- createdHeight
- cosmosSdkVersion
- akashVersion
- ipRegion
- ipRegionCode
- ipCountry
- ipCountryCode
- ipLat
- ipLon
- uptime1d
- uptime7d
- uptime30d
- isValidVersion
- isOnline
- lastOnlineDate
- isAudited
- gpuModels
- attributes
- host
- organization
- statusPage
- locationRegion
- country
- city
- timezone
- locationType
- hostingProvider
- hardwareCpu
- hardwareCpuArch
- hardwareGpuVendor
- hardwareGpuModels
- hardwareDisk
- featPersistentStorage
- featPersistentStorageType
- hardwareMemory
- networkProvider
- networkSpeedDown
- networkSpeedUp
- tier
- featEndpointCustomDomain
- workloadSupportChia
- workloadSupportChiaCapabilities
- featEndpointIp
/v1/providers/{address}:
get:
summary: Get a provider details.
tags:
- Providers
security: []
parameters:
- schema:
type: string
description: Provider Address
example: akash18ga02jzaq8cw52anyhzkwta5wygufgu6zsz6xc
required: true
name: address
in: path
responses:
'200':
description: Return a provider details
content:
application/json:
schema:
type: object
properties:
owner:
type: string
name:
type: string
nullable: true
hostUri:
type: string
createdHeight:
type: number
email:
type: string
nullable: true
website:
type: string
nullable: true
lastCheckDate:
type: string
nullable: true
deploymentCount:
type: number
leaseCount:
type: number
cosmosSdkVersion:
type: string
akashVersion:
type: string
ipRegion:
type: string
nullable: true
ipRegionCode:
type: string
nullable: true
ipCountry:
type: string
nullable: true
ipCountryCode:
type: string
nullable: true
ipLat:
type: string
nullable: true
ipLon:
type: string
nullable: true
uptime1d:
type: number
uptime7d:
type: number
uptime30d:
type: number
isValidVersion:
type: boolean
isOnline:
type: boolean
lastOnlineDate:
type: string
nullable: true
isAudited:
type: boolean
stats:
type: object
properties:
cpu:
type: object
properties:
active:
type: number
available:
type: number
pending:
type: number
required:
- active
- available
- pending
gpu:
type: object
properties:
active:
type: number
available:
type: number
pending:
type: number
required:
- active
- available
- pending
memory:
type: object
properties:
active:
type: number
available:
type: number
pending:
type: number
required:
- active
- available
- pending
storage:
type: object
properties:
ephemeral:
type: object
properties:
active:
type: number
available:
type: number
pending:
type: number
required:
- active
- available
- pending
persistent:
type: object
properties:
active:
type: number
available:
type: number
pending:
type: number
required:
- active
- available
- pending
required:
- ephemeral
- persistent
required:
- cpu
- gpu
- memory
- storage
gpuModels:
type: array
items:
type: object
properties:
vendor:
type: string
model:
type: string
ram:
type: string
interface:
type: string
required:
- vendor
- model
- ram
- interface
attributes:
type: array
items:
type: object
properties:
key:
type: string
value:
type: string
auditedBy:
type: array
items:
type: string
required:
- key
- value
- auditedBy
host:
type: string
nullable: true
organization:
type: string
nullable: true
statusPage:
type: string
nullable: true
locationRegion:
type: string
nullable: true
country:
type: string
nullable: true
city:
type: string
nullable: true
timezone:
type: string
nullable: true
locationType:
type: string
nullable: true
hostingProvider:
type: string
nullable: true
hardwareCpu:
type: string
nullable: true
hardwareCpuArch:
type: string
nullable: true
hardwareGpuVendor:
type: string
nullable: true
hardwareGpuModels:
type: array
items:
type: string
hardwareDisk:
type: array
items:
type: string
featPersistentStorage:
type: boolean
featPersistentStorageType:
type: array
items:
type: string
hardwareMemory:
type: string
nullable: true
networkProvider:
type: string
nullable: true
networkSpeedDown:
type: number
networkSpeedUp:
type: number
tier:
type: string
nullable: true
featEndpointCustomDomain:
type: boolean
workloadSupportChia:
type: boolean
workloadSupportChiaCapabilities:
type: array
items:
type: string
featEndpointIp:
type: boolean
uptime:
type: array
items:
type: object
properties:
id:
type: string
isOnline:
type: boolean
checkDate:
type: string
required:
- id
- isOnline
- checkDate
required:
- owner
- name
- hostUri
- createdHeight
- email
- website
- lastCheckDate
- deploymentCount
- leaseCount
- cosmosSdkVersion
- akashVersion
- ipRegion
- ipRegionCode
- ipCountry
- ipCountryCode
- ipLat
- ipLon
- uptime1d
- uptime7d
- uptime30d
- isValidVersion
- isOnline
- lastOnlineDate
- isAudited
- stats
- gpuModels
- attributes
- host
- organization
- statusPage
- locationRegion
- country
- city
- timezone
- locationType
- hostingProvider
- hardwareCpu
- hardwareCpuArch
- hardwareGpuVendor
- hardwareGpuModels
- hardwareDisk
- featPersistentStorage
- featPersistentStorageType
- hardwareMemory
- networkProvider
- networkSpeedDown
- networkSpeedUp
- tier
- featEndpointCustomDomain
- workloadSupportChia
- workloadSupportChiaCapabilities
- featEndpointIp
- uptime
'400':
description: Invalid address
'404':
description: Provider not found
/v1/providers/{providerAddress}/active-leases-graph-data:
get:
tags:
- Providers
security: []
parameters:
- schema:
type: string
example: akash18ga02jzaq8cw52anyhzkwta5wygufgu6zsz6xc
required: true
name: providerAddress
in: path
responses:
'200':
description: Returns a provider's active leases graph data
content:
application/json:
schema:
type: object
properties:
currentValue:
type: number
compareValue:
type: number
snapshots:
type: array
items:
type: object
properties:
date:
type: string
example: '2021-07-01T00:00:00.000Z'
value:
type: number
example: 100
required:
- date
- value
now:
type: object
properties:
count:
type: number
example: 100
required:
- count
compare:
type: object
properties:
count:
type: number
example: 100
required:
- count
required:
- currentValue
- compareValue
- snapshots
- now
- compare
'400':
description: Invalid address
/v1/auditors:
get:
tags:
- Providers
security: []
summary: Get a list of auditors.
responses:
'200':
description: List of auditors
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
address:
type: string
website:
type: string
required:
- id
- name
- address
- website
/v1/provider-attributes-schema:
get:
summary: Get the provider attributes schema
tags:
- Providers
security: []
responses:
'200':
description: Return the provider attributes schema
content:
application/json:
schema:
type: object
properties:
host:
type: object
properties:
key:
type: string
type:
type: string
enum:
- string
- number
- boolean
- option
- multiple-option
required:
type: boolean
description:
type: string
values:
type: array
nullable: true
items:
type: object
properties:
key:
type: string
description:
type: string
value:
nullable: true
required:
- key
- description
required:
- key
- type
- required
- description
email:
type: object
properties:
key:
type: string
type:
type: string
enum:
- string
- number
- boolean
- option
- multiple-option
required:
type: boolean
description:
type: string
values:
type: array
nullable: true
items:
type: object
properties:
key:
type: string
description:
type: string
value:
nullable: true
required:
- key
- description
required:
- key
- type
- required
- description
organization:
type: object
properties:
key:
type: string
type:
type: string
enum:
- string
- number
- boolean
- option
- multiple-option
required:
type: boolean
description:
type: string
values:
type: array
nullable: true
items:
type: object
properties:
key:
type: string
description:
type: string
value:
nullable: true
required:
- key
- description
required:
- key
- type
- required
- description
website:
type: object
properties:
key:
type: string
type:
type: string
enum:
- string
- number
- boolean
- option
- multiple-option
required:
type: boolean
description:
type: string
values:
type: array
nullable: true
items:
type: object
properties:
key:
type: string
description:
type: string
value:
nullable: true
required:
- key
- description
required:
- key
- type
- required
- description
tier:
type: object
properties:
key:
type: string
type:
type: string
enum:
- string
- number
- boolean
- option
- multiple-option
required:
type: boolean
description:
type: string
values:
type: array
nullable: true
items:
type: object
properties:
key:
type: string
description:
type: string
value:
nullable: true
required:
- key
- description
required:
- key
- type
- required
- description
status-page:
type: object
properties:
key:
type: string
type:
type: string
enum:
- string
- number
- boolean
- option
- multiple-option
required:
type: boolean
description:
type: string
values:
type: array
nullable: true
items:
type: object
properties:
key:
type: string
description:
type: string
value:
nullable: true
required:
- key
- description
required:
- key
- type
- required
- description
location-region:
type: object
properties:
key:
type: string
type:
type: string
enum:
- string
- number
- boolean
- option
- multiple-option
required:
type: boolean
description:
type: string
values:
type: array
nullable: true
items:
type: object
properties:
key:
type: string
description:
type: string
value:
nullable: true
required:
- key
- description
required:
- key
- type
- required
- description
country:
type: object
properties:
key:
type: string
type:
type: string
enum:
- string
- number
- boolean
- option
- multiple-option
required:
type: boolean
description:
type: string
values:
type: array
nullable: true
items:
type: object
properties:
key:
type: string
description:
type: string
value:
nullable: true
require
# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/akash/refs/heads/main/openapi/akash-providers-api-openapi.yml