Skip to content

ouis.md

Latest commit

 

History

History
138 lines (120 loc) · 4.7 KB

ouis.md

File metadata and controls

138 lines (120 loc) · 4.7 KB
Raw
description Organization Unique Identifiers

OUIs

OUIs are used to assign part of the global address space to a given set of router addresses. Hotspots that see device traffic will look up the router address for the given device OUI and offer the device data to registered router.

{% api-method method="get" host="https://api.helium.io" path="/v1/ouis" %} {% api-method-summary %} List OUIs {% endapi-method-summary %}

{% api-method-description %} Lists all OUI transactions known to the blockchain.

This route is cursor paginated. {% endapi-method-description %}

{% api-method-spec %} {% api-method-request %} {% api-method-query-parameters %} {% api-method-parameter name="cursor" type="string" required=false %} Cursor for page of results to fetch {% endapi-method-parameter %} {% endapi-method-query-parameters %} {% endapi-method-request %}

{% api-method-response %} {% api-method-response-example httpCode=200 %} {% api-method-response-example-description %}

{% endapi-method-response-example-description %}

{
    "data": [
        {
            "addresses": [],
            "fee": 40000,
            "filter": "wVwCiewtCpEKAAAAAAAAAAAAcCK3fwAAAAAAAAAAAABI7IQOAHAAAAAAAAAAAAAAAQAAADBlAAAAAAAAAAAAADEAAAA2AAAAOgAAAA",
            "hash": "ojYvEpRioAgxYOU2U5ImmFGd0dlY0CIYRpRjT_mIGT8",
            "height": 464320,
            "oui": 3,
            "owner": "14oSuAgRmAFPFPZRY1MUwir5AJSLGkaXHzuSZJ92BuYCfLMN1Et",
            "payer": "1Wh4bh",
            "requested_subnet_size": 8,
            "staking_fee": 90000000,
            "time": 1598072417,
            "type": "oui_v1"
        },
        {
            "addresses": [
                "1124CJ9yJaHq4D6ugyPCDnSBzQik61C1BqD9VMh1vsUmjwt16HNB"
            ],
            "fee": 0,
            "filter": "wVwCiewtCpEKAAAAAAAAAAAAcCK3fwAAAAAAAAAAAABI7IQOAHAAAAAAAAAAAAAAAQAAADBlAAAAAAAAAAAAADEAAAA2AAAAOgAAAA",
            "hash": "6B4Tp8bST9lTmhPP7VXaW7WN8UMhLiHP8sESjV-3R1E",
            "height": 330396,
            "oui": 2,
            "owner": "13DKnYxcXXEbqfT257cpmszpbdPsDX4vd3kY8Df5rxgQHHMdyPS",
            "owner_signature": "-t5YN-F3tyIbxAtj9EFszmRor-xFR-xPZWRl0y1CfVz031W1FgR-ToYFn-ZG5cUiJanN941Y_YM0IEfrES32Bw",
            "payer": "14fzfjFcHpDR1rTH8BNPvSi5dKBbgxaDnmsVPbCjuq9ENjpZbxh",
            "payer_signature": "khA6zWtpRO6_G-yXWZAUEC-t7oGyAQ90GA_deil_cKhK1lV7Rr5ophdl2m0XWbKYGd82NdGe2Vhm-uE34OXgBA",
            "requested_subnet_size": 1024,
            "staking_fee": 1,
            "time": 1589296612,
            "type": "oui_v1"
        },
        {
            "addresses": [
                "112qB3YaH5bZkCnKA5uRH7tBtGNv2Y5B4smv1jsmvGUzgKT71QpE"
            ],
            "fee": 0,
            "filter": "wVwCiewtCpEKAAAAAAAAAAAAcCK3fwAAAAAAAAAAAABI7IQOAHAAAAAAAAAAAAAAAQAAADBlAAAAAAAAAAAAADEAAAA2AAAAOgAAAA",
            "hash": "6ACW9A5Hj3KDnOJELWAvAVG3yM71OpNAYpdAPM3ti1A",
            "height": 330388,
            "oui": 1,
            "owner": "13tyMLKRFYURNBQqLSqNJg9k41maP1A7Bh8QYxR13oWv7EnFooc",
            "owner_signature": "9YCUVCQIUry7d6iJjBiLtvs8dlg_OBW3j3Vq2OGkSxS5E6qnwRKUtwXirVQpL9uqseVt125k7utUm87bH85sAw",
            "payer": "14fzfjFcHpDR1rTH8BNPvSi5dKBbgxaDnmsVPbCjuq9ENjpZbxh",
            "payer_signature": "tQqX9Y2Lfr78-oghzmYiG8X3E4yAQ67UfXQ_7gsaR7KFWVY8QruqfFdAK485OOvGnpBXkWk8gqWJ--EYMqqxDg",
            "requested_subnet_size": 1024,
            "staking_fee": 1,
            "time": 1589296156,
            "type": "oui_v1"
        }
    ]
}

{% endapi-method-response-example %} {% endapi-method-response %} {% endapi-method-spec %} {% endapi-method %}

{% api-method method="get" host="https://api.helium.io" path="/v1/ouis/last" %} {% api-method-summary %} Last assigned OUI {% endapi-method-summary %}

{% api-method-description %} Returns the last assigned OUI transaction. The last assigned OUI can be used to request a new OUI {% endapi-method-description %}

{% api-method-spec %} {% api-method-request %}

{% api-method-response %} {% api-method-response-example httpCode=200 %} {% api-method-response-example-description %}

{% endapi-method-response-example-description %}

{
    "data": {
        "addresses": [],
        "fee": 40000,
        "filter": "wVwCiewtCpEKAAAAAAAAAAAAcCK3fwAAAAAAAAAAAABI7IQOAHAAAAAAAAAAAAAAAQAAADBlAAAAAAAAAAAAADEAAAA2AAAAOgAAAA",
        "hash": "ojYvEpRioAgxYOU2U5ImmFGd0dlY0CIYRpRjT_mIGT8",
        "height": 464320,
        "oui": 3,
        "owner": "14oSuAgRmAFPFPZRY1MUwir5AJSLGkaXHzuSZJ92BuYCfLMN1Et",
        "payer": "1Wh4bh",
        "requested_subnet_size": 8,
        "staking_fee": 90000000,
        "time": 1598072417,
        "type": "oui_v1"
    }
}

{% endapi-method-response-example %} {% endapi-method-response %} {% endapi-method-spec %} {% endapi-method %}